接口文檔模板

1、XXX公司XXXXXXXX接口規(guī)范作者：xxx版本：1.0.1創(chuàng)建日期：2020年4月20日修訂歷史版本日期版本說明作者2020-4-201.0初版xxx1、簡介本文檔詳細(xì)定義了某某某系統(tǒng)對外提供接口規(guī)范和調(diào)用方法。登錄接口規(guī)范； 修改密碼接口規(guī)范；編輯資料接口規(guī)范；其它；本文檔旨在給第三方實(shí)現(xiàn)接口開發(fā)提供參考。2、接口規(guī)范2.1 測試地址例：http:xxx.x.x.x:8080/2.2 簽名方法例：sign=Md5（字段1+字段2+字段3+秘鑰）；注：秘鑰請聯(lián)系業(yè)務(wù)人員獲取，一般不會公開使用。2.3 加密解密加密：所有字段都必須加密后請求，否則調(diào)用失敗，sign字段請拼接完成后再使用加密方

2、法。解密：返回報(bào)文data字段需解密操作。附件：提供加解密方法。2.4其它公共內(nèi)容可自行添加。2.5接口請求詳細(xì)2.5.1登錄接口規(guī)范功能描述該接口是實(shí)現(xiàn)調(diào)用驗(yàn)證登錄及獲取登錄信息。接口方式http POST接口地址http:/應(yīng)用地址/登錄地址/xxx接口方法請求字段參數(shù)名中文描述回約束sign簽名String必填code工號String必填password密碼String必填返回（JSON格式）參數(shù)說明res_code返回碼res_msg結(jié)果提示信息data用戶信息"name":"姓名", "age":"年齡"

3、, "sex"："性別"，2.5.2修改密碼接口規(guī)范功能描述該接口是實(shí)現(xiàn)調(diào)用修改密碼。接口方式http POST接口地址http:/應(yīng)用地址/修改密碼/xxx接口方法請求字段參數(shù)名中文描述約束sign簽名String必填code工號String必填password密碼String必填newPassword新密碼String必填返回（JSON格式）參數(shù)說明res_code返回碼res_msg結(jié)果提示信息2.5.3編輯資料接口規(guī)范功能描述該接口是實(shí)現(xiàn)調(diào)用修改用戶資料。接口方式http POST接口地址http:/應(yīng)用地址/編輯資料/xxx接口方法請求字段參數(shù)

4、名中文描述回約束sign簽名String必填code工號String必填passWord密碼String必填age年齡String選填sex性別String選填name姓名String選填返回（JSON格式）參數(shù)說明res_code返回碼res_msg結(jié)果提示信息2.5.4其它接口規(guī)范功能描述該接口是實(shí)現(xiàn)調(diào)用驗(yàn)證其它功能。接口方式http POST接口地址http:/ 應(yīng)用地址/其它/xxx接口方法請求字段參數(shù)名中文描述約束XxxXxxString必填XxxXxxString必填XxxXxxString必填返回（JSON格式）參數(shù)說明res_code返回碼res_msg結(jié)果提示信息data用戶信息"xxx": "xxx","xxx": "xxx","xxx": "xxx", 2.6返回碼說明序號返回碼說明10000驗(yàn)證通過，請求成功