三年前小編在 ALPHA Camp 文章下面對於 API document 的留言,剛好看到就轉回來分享。
後來也應 線上讀書會 的邀請分享了一個 talk,大家對於該如何選擇 API document 工具也可以參考看看這個影片喔!
---
Apiary 很強大,但之前是考量到我們的 API 文件有點敏感,所以不敢放在第三方服務裡面,所以就改用 Apiary 所提供的 API Blueprint 來撰寫。
而且 API Blueprint 有一卡車的 extension,我們部門就使用 API Blueprint 寫完文件之後,然後用 aglio 來 deploy 到內部機器上,不怕外留。
https://imgur.com/a/dMB6n
left sidebar 顯示的是目前所有的 API,右邊可以針對每個 API 寫不同的內容,就是跟Apiary 一樣的語法 (API Blueprint),個人覺得很方便。
另外也有 Mock server 可以綁在這上面,一樣是可以架在內部機器,然後再用 Postman去做測試。
---
* API Blueprint - API 文件規範的三大領頭之一:https://www.facebook.com/kewang.information/posts/1940647046211660
#api #apiary #apiblueprint #aglio #alphacamp
同時也有10000部Youtube影片,追蹤數超過2,910的網紅コバにゃんチャンネル,也在其Youtube影片中提到,...