作為后端開發者，如何更優雅、便捷的生成接口文檔？

對于一個后端人員，給可愛的前端妹子或者帥氣的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格式的參數導入，參數格式可以如下：

{ 123, "我是標題"}

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

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

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

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

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

id：“我是文章Id”

title：“我是文章標題”

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

這個小功能是不是節約了開發小伙伴很多時間呢？

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

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

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

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

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

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

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

很多小伙伴問，為什么apipost 導出文檔響應為空？那是因為你么有添加響應示例。

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

API API調用

版權聲明：本文內容由網絡用戶投稿，版權歸原作者所有，本站不擁有其著作權，亦不承擔相應法律責任。如果您發現本站中有涉嫌抄襲或描述失實的內容，請聯系我們jiasou666@gmail.com 處理，核實后本網站將在24小時內刪除侵權內容。