接口文檔

編輯 API

我們在開始一個(gè)新接口之前，需要進(jìn)行以下判斷：

• 請求協(xié)議是不是 HTTP/HTTPS？
• 請求體和響應(yīng)體格式是什么(XML、JSON、FormData、Raw)？
• API 是不是 RESTful 風(fēng)格？

如果上面三個(gè)問題的答案都清楚了，就可以開始新增一個(gè) API 接口。

API 信息

在編輯 API 的頂部填寫 API 的請求協(xié)議、方式、地址、名稱；

協(xié)議支持

• HTTP/HTTPS

請求方式支持

• POST
• GET
• PUT
• DELETE
• HEAD
• OPTIONS
• PATCH

API 請求參數(shù)

設(shè)置請求頭部

你可以輸入或?qū)胝埱箢^部。

除了手動輸入，你還可以批量導(dǎo)入請求頭部，數(shù)據(jù)格式為 key : value ，一行一條 header 信息，如：

Connection: keep-alive
Content-Encoding: gzip
Content-Type: application/json
Date: Mon, 30 Dec 2019 20:49:45 GMT

設(shè)置請求體

請求體提供了五種類型：

1. Form-data（表單）
2. Json
3. XML
4. Raw（自定義文本類型數(shù)據(jù)）

設(shè)置 Query 參數(shù)

Query 參數(shù)指的是地址欄中跟在問號？后面的參數(shù)，如以下地址中的 user_name 參數(shù)：

/user/login?user_name=jackliu

批量導(dǎo)入的數(shù)據(jù)格式為 ?key=value... ，通過&分隔多個(gè)參數(shù)，如：

api.eolinker.com/user/login?user_name=jackliu&user_password=hello

設(shè)置 REST 參數(shù)

REST 參數(shù)指的是地址欄被斜杠/分隔的參數(shù)，如以下地址中的使用大括號包裹起來的 user_name、user_password 參數(shù)：

/user/login/{user_name}/{user_password}

WARNING
注意，你只需要在 URL 中使用 {} 將 REST 參數(shù)括起來，表單的參數(shù)名不需要填寫 {}。

API 響應(yīng)內(nèi)容

設(shè)置響應(yīng)頭部

你可以輸入或?qū)腠憫?yīng)頭部。批量導(dǎo)入的數(shù)據(jù)格式為 key : value ，一行一條 header 信息，如：

Connection: keep-alive
Content-Encoding: gzip
Content-Type: application/json
Date: Mon, 30 Dec 2019 20:49:45 GMT

設(shè)置響應(yīng)內(nèi)容

響應(yīng)內(nèi)容的編寫方式和請求參數(shù)的類似，響應(yīng)內(nèi)容提供了四種類型：

1. Json
2. XML
3. Raw（自定義文本類型數(shù)據(jù)）

在使用中有任何問題，可以提 issue 或者進(jìn)用戶群反映，我們都會認(rèn)真對待及時(shí)處理的。

如果你覺得項(xiàng)目還不錯(cuò)，不妨給個(gè) Star 支持一下，這也是我們繼續(xù)優(yōu)化迭代的動力~

項(xiàng)目地址：

Github:https://github.com/Postcatlab/postcat

Gitee:https://gitee.com/eolink_admin/postcat