接口文檔設計

接口文檔設計 做一個好點的接口文檔,就需要像文章一樣顯而易見,需要有封面,目錄,概述,接口信息(接口規範,請求類型,content-type,協議格式,功能說明,接口描述,請求內容,響應內容,示例),時序圖,注意事項,看完這些會發現排版和文章的排版差不多。 整體效果 這裏寫目錄標題 接口文檔設計 1.封面 2.目錄 3.概要(概述) 4.接口信息 5.時序圖 6.注意事項 1.封面 就如同論文的封
相關文章
相關標籤/搜索