寫好接口文檔的方法
來源：懂視網(wǎng)
責(zé)編：小采
時間：2020-11-27 15:26:38
寫好接口文檔的方法
寫好接口文檔的方法:本文主要和大家分享如何寫好接口文檔的方法，希望能幫助大家寫好一個接口文檔。1 HTTP攜帶信息的方式urlheadersbody: 包括請求體，響應(yīng)體2 分離通用信息一般來說，headers里的信息都是通用的，可以提前說明，作為默認(rèn)參數(shù)3 路徑中的參數(shù)表達(dá)式URL中參數(shù)表
導(dǎo)讀寫好接口文檔的方法:本文主要和大家分享如何寫好接口文檔的方法，希望能幫助大家寫好一個接口文檔。1 HTTP攜帶信息的方式urlheadersbody: 包括請求體，響應(yīng)體2 分離通用信息一般來說，headers里的信息都是通用的，可以提前說明，作為默認(rèn)參數(shù)3 路徑中的參數(shù)表達(dá)式URL中參數(shù)表
一些文檔里可能會加入字段的類型，但是我認(rèn)為這是沒必要的。以為HTTP傳輸?shù)臄?shù)據(jù)往往都需要序列化，大部分?jǐn)?shù)據(jù)類型都是字符串。一些特殊的類型，例如枚舉類型的字符串，可以在說明里描述。
另外：數(shù)據(jù)模型非常建議使用表格來表現(xiàn)。
舉個栗子
聲明：本網(wǎng)頁內(nèi)容旨在傳播知識，若有侵權(quán)等問題請及時與本網(wǎng)聯(lián)系，我們將在第一時間刪除處理。TEL:177 7030 7066 E-MAIL:11247931@qq.com
寫好接口文檔的方法
寫好接口文檔的方法:本文主要和大家分享如何寫好接口文檔的方法，希望能幫助大家寫好一個接口文檔。1 HTTP攜帶信息的方式urlheadersbody: 包括請求體，響應(yīng)體2 分離通用信息一般來說，headers里的信息都是通用的，可以提前說明，作為默認(rèn)參數(shù)3 路徑中的參數(shù)表達(dá)式URL中參數(shù)表
