三年前小編在 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影片中提到,...
apiblueprint 在 Kewang 的資訊進化論 Facebook 的最佳貼文
昨天應 Hsiang An Chi 邀請,來分享一下如何使用 API Blueprint 來撰寫 API 文件。
現在 API 文件各家爭鳴,不過大家比較知道的就是 Swagger, RAML 跟 API Blueprint 這三家,而小編覺得 API Blueprint 使用 Markdown 的寫法比較直覺,所以兩三年前在 survey 時就決定使用這套,部門內部的 API 開發文件也是使用 API Blueprint 來撰寫。
另外也分享從 API Blueprint 衍生出來的 MSON 格式,並且給了一些可以如何使用 MSON 的方向給大家參考。對 API 文件撰寫不知如何下手的朋友可以來看看喔。
* Slideshare:https://www.slideshare.net/kewang/api-blueprint-api
* 線上 api 讀書會直播連結:https://www.facebook.com/groups/1849067925350226/permalink/1961997177390633/
* 更清晰版本:https://www.youtube.com/watch?v=gtrHGPlZaf4
#apiblueprint #mson #swagger #raml #apiary
apiblueprint 在 Kewang 的資訊進化論 Facebook 的最佳解答
天啊!!!!!!
比起昨天 Google 買下 Fabric 的新聞,近兩天讓小編最震驚的圈內消息,應該還是 Apiary (也就是開發 API Blueprint 的母公司) 被 Oracle 買走了!這類製作 API document 的生態系,當紅的有三間公司,依小編喜好度分別為 Apiary, RAML, Swagger。
而現在 Oracle 把 Apiary 買走之後,雖然資源(錢)應該是變多,但就歷次收購的下場看來會不會是另一項失敗的投資呢?Orz
https://en.m.wikipedia.org/wiki/List_of_acquisitions_by_Oracle 這一頁看來又要再記上一筆了
#apiary #oracle #apiblueprint #raml #swagger