其實對於介面文件，就是用來傳遞介面的資訊，包括介面的資料傳遞，資料的請求，那麼，文件的可讀性就異常重要了。
當然word，txt，都可以用來寫介面文件，只不過，對於word的各種格式，不見得所有程式猿都了然於胸，這個時候想讓介面文件變得簡潔美觀，可讀性優良的話，markdown就可以閃亮登場了。
下面記錄一下，markdown的基本語法，因為編寫markdown檔案，很多編輯器都可以，比如phpstorm 再比如sublime text,notepad++,等等。
在想要設定為標題的文字前面加#來表示
乙個#是一級標題，二個#是二級標題，以此類推。支援六級標題。
示例：
# 這是一級標題
## 這是二級標題
### 這是**標題
#### 這是四級標題
##### 這是五級標題
###### 這是六級標題
這是四級標題
這是五級標題
這是六級標題
要加粗的文字左右分別用兩個*號包起來
要傾斜的文字左右分別用乙個*號包起來
要傾斜和加粗的文字左右分別用三個*號包起來
要加刪除線的文字左右分別用兩個~~號包起來
示例：
**這是加粗的文字**
*這是傾斜的文字*`
***這是斜體加粗的文字***
~~這是加刪除線的文字~~
這是加粗的文字
這是傾斜的文字
這是斜體加粗的文字
這是加刪除線的文字
在引用的文字前加》即可。引用也可以巢狀，如加兩個》三個》
n個...
貌似可以一直加下去，但沒神馬卵用
示例：
>這是引用的內容
>>這是引用的內容
>>>>>>>>>>這是引用的內容
這是引用的內容這是引用的內容
這是引用的內容
三個或者三個以上的 - 或者 * 都可以。
示例：
---
----
********
可以看到，顯示效果是一樣的。
語法：title可加可不加
示例：
示例語法：
無序列錶用 - + * 任何一種都可以
- 列表內容
+ 列表內容
* 列表內容
注意：- + * 跟內容之間都要有乙個空格
語法：數字加點
1.列表內容
2.列表內容
3.列表內容
注意：序號跟內容之間要有空格
1.列表內容
2.列表內容
3.列表內容
一級無序列表內容
二級有序列表內容
二級有序列表內容
二級有序列表內容
一級有序列表內容
一級有序列表內容
二級有序列表內容
二級有序列表內容
二級有序列表內容
語法：
表頭|表頭|表頭
---|:--:|---:
內容|內容|內容
內容|內容|內容
第二行分割表頭和內容。
- 有乙個就行，為了對齊，多加了幾個
文字預設居左
-兩邊加：表示文字居中
-右邊加：表示文字居右
注：原生的語法兩邊都要用 | 包起來。此處省略
姓名|技能|排行
--|:--:|--:
劉備|哭|大哥
關羽|打|二哥
張飛|罵|三弟
姓名技能
排行劉備哭大哥
關羽打二哥張飛罵三弟
語法：單行**：**之間分別用乙個反引號包起來
`**內容`(```)
**...
**...
**...
(```)
注：為了防止轉譯，前後三個反引號處加了小括號，實際是沒有的。這裡只是用來演示，實際中去掉兩邊小括號即可。示例：
單行**
`create database hero;`(```)
function fun()
fun();
(```)
單行**
create database hero;
**塊
function fun()
fun();
yapi 介面文件 介面文件神器YApi
阿八個人部落格 1190000020220258 什麼是yapi github 官網上是這麼介紹的 yapi 是乙個可本地部署的 打通前後端及qa的 視覺化的介面管理平台 可以這麼說yapi兼具swagger,rap2,postman的各項優點why yapi 如果你想要乙個好用的介面管理平台，那麼...
Android 介面文件
前言 一 設定描述 設計描述，主要是介紹專案介面文件的業務及主要功能介紹，有互動方式 json資料互動格式 命名規則等做細分講解。1 介面的呼叫方式 移動端通過webservice和其他通用的請求方式，呼叫伺服器介面，返回json資料。2 json的結構 請求失敗示例 請求成功示例 字段解析 sta...
介面文件格式
幻寵大陸 專案協議文件 協議格式說明 遊戲系統中協議是由兩部分組成 協議頭 協議體。其中協議頭的資料長度為固定。如下顯示 客戶端傳送的訊息格式 字段意義 字段型別 說明訊息長度 int描述協議體的長度，包括當前 訊息頭short 協議 id 訊息回執碼 short 壓縮或加密的標識，或者是回執碼 訊...