資訊專欄INFORMATION COLUMN
前言
今天發現了一個很niubility的東西__API Blueprint__,先給出官網https://apiblueprint.org/。下面是官網給出的介紹：
API Blueprint. A powerful high-level API description language for web APIs.
這個可以干什么呢？按照API Blueprint的語法(類似markdown)，我們可以利用生態鏈工具：
生成API接口文檔
模擬接口在你沒寫任何代碼之前
待研究...
對于__1__因為之前調研過Swagger等工具還是關注過一段時間寫接口文檔的事情，當時選取的方案就是Swagger,當時也覺的挺好用的，最后的接口文檔也是可以真實返回數據的，但是問題呢就是寫Swagger依賴的json文檔是個問題，官方支持的語法是yaml(要是markdown多好啊)，直接手動維護所有接口的json文檔很X疼的啊，最后發現一個sosoapi的東東可以生成Swagger依賴的json文檔，但是沒開源啊！?。∷允褂靡沁x型API Blueprint語法作為接口文檔書寫標準，的確是個不錯的選擇。
貼一下Swagger的官網http://swagger.io/
其次，API Blueprint最讓我覺得厲害的就是我曾經幻想的：先制定接口數據結構，然后通過這個數據結構先模擬接口響應，之后客戶端的同學和后端的同學就可并行的開發，客戶端的同學再也不用等到后端的同學開發完畢再對接接口了，后端同學開發完畢無縫切換到真實代碼上即可。
試用工具選用
看了生態鏈下眼花繚亂的工具，先選了個go開發的工具snowboard
安裝
// linux下安裝，這里安裝的是v0.5.0版 wget https://github.com/subosito/snowboard/releases/download/v0.5.0/snowboard-v0.5.0.linux-amd64.tar.gz tar -zxvf snowboard-v0.5.0.linux-amd64.tar.gz ./snowboard -h // mac下安裝 $ brew tap subosito/packages $ brew install snowboard
編寫第一個接口文檔
新建一個.apib后綴的文件api.apib
推薦api-blueprint語法插件：language-api-blueprint 例如，Atom
編寫接口文檔
// 示例
# API
## GET /v1/message
+ Response 200 (application/json)
{
"status":"OK",
"result":
{
"lists":[
{"id":666},
{"id":888}
],
"count":10
}
}
生成接口文檔html頁面
// 命令 ./snowboard html -i api.apib -o api.html -s
訪問 http://127.0.0.1:8088/
啟用接口模擬
// 命令 ./snowboard mock -i api.apib // 返回 Mock server is ready. Use 127.0.0.1:8087 Available Routes: GET 200 /v1/message
訪問 http://127.0.0.1:8087/v1/message
是不是很不錯的東西，提高生產效率的利器啊，哈哈～ 我今天才知道.......... 看它還有很多的工具，包含和Swagger結合使用的，后續慢慢研究，今天先過了個新鮮勁～
文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。
轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/22486.html
摘要：是一套描述標準，和一樣，屬于一種標記語言，可以把標記文稿轉換成漂亮的接口文檔。還可以創建，進行本地調試。一語法只要用寫過東西基本很快就能掌握語法。參考文檔使用編寫文檔用生成優雅的文檔指導手冊用生成優雅的文檔 前后端配合開發的時候，常常會有這樣一種需求：你接口定義好了嗎？能不能先幫我起一個 Mock Server 先跑起來？那么，如何才能避免前后端開發在時間差上的無謂等待呢？api-bl...
摘要：移動端應用一般都運行在微信瀏覽器中中手機瀏覽器中。因為微信瀏覽器是定制的瀏覽器，一般的遠程調試方式都不可用，需要配合特定的工具，如微信開發者工具。 前端如何高效的與后端協作開發 1. 前后端分離 前端與后端的分離，能使前端的開發脫離后端的開發模式，擁有更大的自由度，以此便可做前端工程化、組件化、單頁面應用等。 可以參考：前后端分離、web與static服務器分離 2. 盡量避免后端模板...
摘要：移動端應用一般都運行在微信瀏覽器中中手機瀏覽器中。因為微信瀏覽器是定制的瀏覽器，一般的遠程調試方式都不可用，需要配合特定的工具，如微信開發者工具。 前端如何高效的與后端協作開發 1. 前后端分離 前端與后端的分離，能使前端的開發脫離后端的開發模式，擁有更大的自由度，以此便可做前端工程化、組件化、單頁面應用等。 可以參考：前后端分離、web與static服務器分離 2. 盡量避免后端模板...
閱讀 2565·2021-10-11 10:58
閱讀 1148·2021-09-29 09:34
閱讀 1486·2021-09-26 09:46
閱讀 3830·2021-09-22 15:31
閱讀 730·2019-08-30 15:54
閱讀 1458·2019-08-30 13:20
閱讀 1251·2019-08-30 13:13
閱讀 1486·2019-08-26 13:52
