API接口文檔(簡(jiǎn)單版)

1、XX接口文檔V1.0XX接口文檔V1.0制作：yibyli說(shuō)明：包含有基本的 API格式，帶有大綱，目錄，頁(yè)眉1XX接口文檔V1.0目錄目錄21. 登陸21.1 描述21.2 請(qǐng)求地址21.3 請(qǐng)求參數(shù)21.4 返回?cái)?shù)據(jù)21.5 請(qǐng)求URL實(shí)例 21.6 返回?cái)?shù)據(jù)實(shí)例 32. API 名稱(chēng)32.1 描述32.2 請(qǐng)求地址32.3 請(qǐng)求參數(shù)32.4 返回?cái)?shù)據(jù)32.5 請(qǐng)求URL實(shí)例 32.6 返回?cái)?shù)據(jù)實(shí)例 31.登陸1.1描述登陸的接口1.2請(qǐng)求地址操作login協(xié)議HTTP方式GETULR全徑請(qǐng)求的URL地址的全稱(chēng)1.3請(qǐng)求參數(shù)序號(hào)參數(shù)名中文名稱(chēng)必選數(shù)據(jù)類(lèi)型長(zhǎng)度備注1para1第一個(gè)參數(shù)YSt

2、ring20這個(gè)API的第一個(gè)參數(shù)2Para2第二個(gè)參數(shù)NString20這個(gè)API的第二個(gè)參數(shù)1.4返回?cái)?shù)據(jù)序號(hào)返回值中文名稱(chēng)備注1code請(qǐng)求狀態(tài)碼200請(qǐng)求成功，400請(qǐng)求失?。▍?shù)有誤，等）2data返回?cái)?shù)據(jù)數(shù)組,數(shù)組中可能有鍵值對(duì)3result返回結(jié)果0發(fā)送驗(yàn)證碼成功，1失敗1.5請(qǐng)求URL實(shí)例 n?n ame=xx&password=1010（例子并不可以使用）1.6返回?cái)?shù)據(jù)實(shí)例"code":200,"data":"result":12. API名稱(chēng)2.1描述這個(gè)API是用來(lái)做什么的，以及注意點(diǎn)2.2請(qǐng)求地址操作操作名稱(chēng)協(xié)議HTTP方式GET地址請(qǐng)求的URL地址的全稱(chēng)2.3請(qǐng)求參數(shù)序號(hào)參數(shù)名中文名稱(chēng)必選數(shù)據(jù)類(lèi)型長(zhǎng)度備注1para1第一個(gè)參數(shù)YString20這個(gè)API的第一個(gè)參數(shù)2Para2第二個(gè)參數(shù)NString20這個(gè)API的第二個(gè)參數(shù)2.4返回?cái)?shù)據(jù)序號(hào)返回值中文名稱(chēng)備注1code請(qǐng)求狀態(tài)碼200請(qǐng)求成功,400請(qǐng)求失?。▍?shù)有誤，等）2data返回?cái)?shù)據(jù)數(shù)組,數(shù)組中可能有鍵值對(duì)3result返回結(jié)果0發(fā)送驗(yàn)證碼成功，1失敗2.5請(qǐng)求URL實(shí)例 name=xx&password=10102.6返回?cái)?shù)據(jù)實(shí)例"code&quo