一個完整的API文檔包含的內容

一個完整的API文檔應該包含以下幾部分： ① 接口名稱。 ② 簡要描述。 ③ 請求的URL。 ④ 請求方式（GET / POST等）。 ⑤ 請求參數（參數名、是否必選、參數類型、說明）。 ⑥ 返回示例。 ⑦ 返回參數說明（參數名、類型、說明）。 ⑧ 備註及責任人。 內容來源： 有興趣的可以去讀讀這本書

>>阅读原文<<