做爲後端開發者，如何更優雅、便捷的生成接口文檔？

對於一個後端人員，給可愛的前端妹子或者帥氣的app開發小哥哥生成接口文檔是一件必不可少而又十分頭疼的事情。一般狀況下，咱們會用postman調試接口，而後用rap、甚至word等工具再編寫接口文檔，重複工做，十分難受。

apipost的出現，解決了全部後端開發人員的痛點。

apipost的定位是：一款提高開發、測試團隊效率，可直接生成文檔的API調試、管理工具。

它的便捷之處，便在於它不只完美支持相似postman的接口調試功能，並且更重要的是，它支持快速、優雅的生成漂亮的文檔。

如下界面，就是apipost接口調試控制檯的全貌。

是否是很熟悉？事實上，除了相似postman那些您熟悉的配方和味道的接口調試功能，它也加入了更多適合中國人習慣的小功能。好比：

亮點小功能之：快速導入參數

apipost支持多種格式的參數導入，見下圖，你不再用一個一個參數的慢慢寫了：

導入格式支持key-value和json格式：

1-1：key-value格式導入示例：

key-value格式常見的就是瀏覽器（F12）控制檯的數據格式，見下圖：

咱們，複製以上請求頭參數，而後粘貼到apipost，點擊導入

參數則瞬間導入到了請求參數中，見下圖：

以上示例只是展現瞭如何快速導入到header參數，其餘參數好比query、body操做方式是如出一轍滴。

1-2：json格式導入示例：

apipost也支持json格式的參數導入，參數格式能夠以下：

{
	"id": 123, "title": "我是標題" }

如圖，點擊導入，參數也快速導入到了請求參數中。

亮點小功能之：參數註釋自動識別

上面咱們寫了如何快速導入參數，其實對於生成接口文檔來講，參數描述（註釋）纔是最要命的，對於咱們一直忙碌的程序員，花大量時間用在寫文檔上實在太累！

好在apipost幫咱們節省了不少時間，一個參數，只要寫過一次註釋，下次遇到一樣的參數直接選中就行。舉例：

在上圖中，咱們針對id和title寫了對應的註釋：

id：「我是文章Id」

title：「我是文章標題」

當咱們新建一個接口的時候，假如這個接口一樣用到了 id或者title等參數，點擊參數描述就會呈現出剛剛輸入過的參數描述，直接選中便可，不用再麻煩的打字輸入了。

這個小功能是否是節約了開發小夥伴不少時間呢？

亮點小功能之：快速定位當前接口目錄

左側的目錄默認都是閉合的，有時候咱們不知道當前正在編輯的接口屬於哪一個目錄，找起來至關頭疼。apipost提供了「定位到當前接口目錄」 功能（見下圖），能夠快速打開當前正在編輯的接口、文檔所在的目錄，是否是解決了您的大問題了呢？

其實，apipost還有不少不少更加符合中國人操做習慣的小功能，等待您去發現。

說了這麼多，好像還沒說到重點，apipost怎麼生成接口文檔呢？很簡單：新版ApiPost支持分享單個項目、也支持分享單個目錄或者文檔：

支持設置文檔連接的有效期：

支持設置文檔的查看權限：

小TIPS：apipost 導出文檔響應爲空？

不少小夥伴問，爲何apipost 導出文檔響應爲空？那是由於你麼有添加響應示例。

ApiPost生成的文檔怎麼添加響應示例？很簡單：