作爲Java開發工程師，如何高效優雅地編寫接口文檔

作爲一名優秀的Java開發工程師，編寫接口文檔向來是一件很頭疼的事情。本來就被bug糾纏的很累了，你還讓我幹這？

其實，你可以試試ApiPost。

ApiPost的定位是Postman+Swagger+Mock Server，主要用來發送調試接口和生成接口文檔。如果你願意，也可以用它生成Mock 數據，當Mock Server使用。

下面就簡單介紹如何利用ApiPost調試接口和快速的生成接口文檔，讓您初步體驗ApiPost的魅力！

1. API寫完想要測試？試試模擬發送一次請求

新建接口，我想模擬發送請求如下

curl --location --request POST 'http://apis.juhe.cn/mobile/get?phone=13429667914&key=1950d2a44f1b4b9a671d6c53f3d5b6be'

如圖進行進行配置：

 

點擊發送，查看接口返回結果：

 

 

你可以查看返回數據，返回Header、Cookie、狀態碼、請求時長等等數據。

2. 測試完後我想快速生成文檔給前端看

點擊分享文檔

 

複製並打開文檔地址就可以看到了完整的接口文檔。

 

 

 

3. 後記

恭喜你體驗了第一個接口文檔的旅程。我們的工具同時節省了前後端的開發以及溝通時間。

除此之外ApiPost還有更多更好的功能等您來體驗。