API文件模板

2022-09-14 11:12:07 字數 645 閱讀 6643

版本號

制定人修訂日期

0.0.2

zenghui

2017-09-27

0.0.1

zanshan

2017-02-20

引數名是否必須

型別說明

content-type

是string

content-md5

是string

請求內容簽名

引數名是否必須

型別說明

username

是string

使用者名稱password

是string

密碼

$.ajax(

success : function(r)

});

正確時返回:

}

錯誤時返回:

引數名

型別說明

level

int使用者組id,0:超級管理員;2:普通使用者

username

string

使用者名稱lastlogin

ts上次登入時間

API文件實踐

好的api文件不是隨意就可以生成的。它需要明確的指導方案 團隊一致的努力 嚴格的使用者評審以及在api的整個生命週期中維護文件。如果需要編寫的好的api文件則應該包括 必要的元件。完整的文件通常包含有引數說明 錯誤訊息 響應資訊 示例,以及全面的更改日誌的部分。一些api文件還包括一系列指南,這些指...

介面API文件

在專案開發彙總,web專案的前後端是分離開發的。應用程式的開發,需要由前後端工程師共同定義介面,編寫介面文件,之後大家都根據這個介面文件進行開發,到專案結束前都要一直維護。1 專案開發過程中前後端工程師有乙個統一的檔案進行溝通交流開發 2 專案維護中或者專案人員更迭的時候,方便後期人員檢視 維護 要...

API文件管理

api文件是api生命週期管理的基礎,乙份完善的api文件在整個api管理過程中起著至關重要的重用。它不僅是api使用說明,更是後期維護的重要參考。管理好api文件,對於專案成員來講是乙個長期的挑戰。api生命週期的管理在考慮管理過程是否便捷 靈活的前提下,還需要考慮管理中的質量問題等,api文件管...