使用apipost工具快速生成在線接口文檔

ApiPost是一個支持團隊協做,並可直接生成文檔的API調試、管理工具。它支持模擬POST、GET、PUT等常見請求,是後臺接口開發者或前端、接口測試人員不可多得的工具 。使用者不只能夠利用apiopst調試接口,還能夠書寫相關注釋(接口文檔),方便的生成可讀性好、界面美觀的在線接口文檔。前端

本文主要包含如下內容:linux

介紹ApiPost工具,它能作什麼程序員

下載、安裝的方法json

一些經常使用的操做api

介紹一些使用技巧瀏覽器

前言:apipost能作什麼?

ApiPost是一個支持團隊協做,並可直接生成文檔的API調試、管理工具。它能夠像postman那樣支持模擬POST、GET、PUT等常見請求也能夠快速生成接口文檔,是後臺接口開發者或前端、接口測試人員不可多得的工具 。首先看下它的界面風格。restful

使用apipost工具快速生成在線接口文檔

下載、安裝apipost

ApiPost安裝下載十分簡單,在官網(自行百度)直接下載對應操做系統的安裝包(支持window、mac、linux)安裝便可,官網也提供了豐富的安裝文檔,這裏再也不贅述了。工具

一些經常使用的操做

ApiPost支持常見的接口發送、文檔生成等。做爲一名開發者,相信你從上面截圖就能夠基本看出來它的使用方法。這裏主要介紹一些其餘的常見操做。不過初次使用的時候,須要先註冊一個帳號,建立一個項目,而後點擊左側的 APIS 菜單欄就進到控制檯了。post

如下圖是針對目錄的經常使用操做測試

使用apipost工具快速生成在線接口文檔

總之使用基本很簡單,你下載安裝一看就會了,實在有問題能夠去官網查看文檔或者去社區提問。

一些操做技巧

小技巧之:快速導入參數

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

使用apipost工具快速生成在線接口文檔

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

使用apipost工具快速生成在線接口文檔

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

key-value格式常見的就是瀏覽器(F12)控制檯的數據格式,見下圖:

使用apipost工具快速生成在線接口文檔

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

使用apipost工具快速生成在線接口文檔

參數則瞬間導入到了請求參數中,見下圖:

使用apipost工具快速生成在線接口文檔

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

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

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

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

使用apipost工具快速生成在線接口文檔

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

使用apipost工具快速生成在線接口文檔

小技巧之:參數註釋自動識別

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

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

使用apipost工具快速生成在線接口文檔

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

id:「我是文章Id」

title:「我是文章標題」

當咱們新建一個接口的時候,假如這個接口一樣用到了 id或者title等參數,點擊參數描述就會呈現出剛剛輸入過的參數描述,直接選中便可,不用再麻煩的打字輸入了。使用apipost工具快速生成在線接口文檔

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

小技巧之:快速定位當前接口目錄

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

使用apipost工具快速生成在線接口文檔

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

小技巧之:生成並分享在線接口文檔

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

使用apipost工具快速生成在線接口文檔

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

使用apipost工具快速生成在線接口文檔

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

使用apipost工具快速生成在線接口文檔

小TIPS:apipost 導出文檔響應爲空?

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

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

使用apipost工具快速生成在線接口文檔

小技巧之:快速克隆一個項目

有時候咱們須要複製一個項目的數據,ApiPost如何克隆(複製)一個項目?

很簡單:

使用apipost工具快速生成在線接口文檔

小技巧之:resful風格的接口的路徑變量

相似這樣風格的接口:

http://example.com/api/users/1  //GET 獲取標識爲1用戶信息

ApiPost支持把像這樣的restful風格連接中的uid也就是1做爲參數單獨提出來比較方便調試和解釋。

只須要把URL路徑中的ID設置爲 

:變量名 

便可。

使用apipost工具快速生成在線接口文檔

這樣的話,咱們生成的文檔就會相似:

使用apipost工具快速生成在線接口文檔

相關文章
相關標籤/搜索