成人国产在线小视频_日韩寡妇人妻调教在线播放_色成人www永久在线观看_2018国产精品久久_亚洲欧美高清在线30p_亚洲少妇综合一区_黄色在线播放国产_亚洲另类技巧小说校园_国产主播xx日韩_a级毛片在线免费

資訊專(zhuān)欄INFORMATION COLUMN

使用Api-blueprint文檔創(chuàng)建mock server

ningwang / 3352人閱讀

摘要：是一套描述標(biāo)準(zhǔn)，和一樣，屬于一種標(biāo)記語(yǔ)言，可以把標(biāo)記文稿轉(zhuǎn)換成漂亮的接口文檔。還可以創(chuàng)建，進(jìn)行本地調(diào)試。一語(yǔ)法只要用寫(xiě)過(guò)東西基本很快就能掌握語(yǔ)法。參考文檔使用編寫(xiě)文檔用生成優(yōu)雅的文檔指導(dǎo)手冊(cè)用生成優(yōu)雅的文檔

前后端配合開(kāi)發(fā)的時(shí)候，常常會(huì)有這樣一種需求：
“你接口定義好了嗎？能不能先幫我起一個(gè) Mock Server 先跑起來(lái)？”
那么，如何才能避免前后端開(kāi)發(fā)在時(shí)間差上的無(wú)謂等待呢？api-blueprint，也許就是你想要的福音。

API Blueprint是一套API描述標(biāo)準(zhǔn)，和Markdown一樣，屬于一種標(biāo)記語(yǔ)言，可以把標(biāo)記文稿轉(zhuǎn)換成漂亮的接口文檔。還可以創(chuàng)建 mock server ，進(jìn)行本地調(diào)試。

一、語(yǔ)法

只要用 markdown 寫(xiě)過(guò)東西, 基本很快就能掌握API Blueprint Language 語(yǔ)法。

官方 例子 ，一共也就 10 多個(gè)，耐心看完，心里就大概有數(shù)了；

語(yǔ)法規(guī)范；

官方 解釋器 ，有了這個(gè)解析器，就可以很容易的擴(kuò)展自己的相關(guān)工具了（比如代碼生成等）

二、Mock server

api-mock

drakov

兩者都可以根據(jù) api-blueprint 的文檔創(chuàng)建一個(gè)本地的 mock server 。

安裝與使用都非常簡(jiǎn)單，只要選其中的一種安裝即可，確保本地裝有 node 環(huán)境：

$ node -v

如果能獲取到版本號(hào)，如：

v6.5.0

就可以直接安裝mock工具啦，如果不行的話自行Google一下安裝一個(gè)唄。

2.1 工具一：安裝api-mock 
$ npm install -g api-mock

啟動(dòng) mock server，方法中的 api.md 就是所需 server 的 api-blueprint 文檔名

& api-mock ./api.md --port 3000
2.2 工具二：安裝drakov 
$ npm install -g drakov

啟動(dòng) mock server，方法中的 api.md 就是所需 server 的 api-blueprint 文檔名

$ drakov -f api.md -p 3000
三、生成靜態(tài) HTML

aglio 是一個(gè)可以根據(jù) api-blueprint 文檔生成靜態(tài) HTML 頁(yè)面的工具。

aglio不是簡(jiǎn)單的 markdown 到 html 的轉(zhuǎn)換, 而是可以生成類(lèi)似 rdoc 這樣的擁有特定格式風(fēng)格的查詢文檔

3.1 安裝

確保本地裝有 node 環(huán)境：

$ npm install -g aglio
3.2 生成 HTML 
$ aglio -i api.md -o api.html
四、本地調(diào)試

新建一個(gè) statistics.md 文件, 輸入如下內(nèi)容:

FORMAT: 1A

# Example API

statistics

## 統(tǒng)計(jì) [/statistics]

### 獲取統(tǒng)計(jì)數(shù)據(jù) [GET]

+ Response 200 (application/json)
{
            "success": true, 
            "err_code": "888888", 
            "err_msg": "錯(cuò)誤說(shuō)明",
            "data": [{
                "hour": "2016-10-31",
                "totalIncome": "1000.09",
                "totalRefund": "100.08",
                "incomeOrders": 70,
                "refundOrders": 10,
                "totalOrders": 80
            }]
 }
4.1 生成HTML文檔 
$ aglio -i statistics.md -o statistics.html

點(diǎn)擊查看

4.2 創(chuàng)建 mock server

前面安裝的mock工具是drakov，創(chuàng)建mock服務(wù)的命令行如下：

$ drakov -f ./statistics.md -p 3000

如果你安裝的是api-mock：

$ api-mock ./statistics.md --port 3000

當(dāng)所有的都弄完以后，就可以訪問(wèn)http://localhost:3000/statistics，發(fā)送網(wǎng)絡(luò)請(qǐng)求獲取數(shù)據(jù)，無(wú)需等待，前后端同步進(jìn)行，nice。

參考文檔

使用 API-Blueprint 編寫(xiě) API 文檔

api blueprint

用 API blueprint 生成優(yōu)雅的 RESTful API 文檔

API Blueprint Docker

API Blueprint

API Blueprint 指導(dǎo)手冊(cè)

用 API blueprint 生成優(yōu)雅的 RESTful API 文檔

文章版權(quán)歸作者所有，未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請(qǐng)注明本文地址：http://systransis.cn/yun/35804.html

相關(guān)文章

  • API Blueprint Docker

    摘要：之前雖然了解各種概念，但是自己搗鼓后，才算是真正的理解。只能把文檔渲染成，但是不包括，所以需要配合。這里是啟動(dòng)腳本，看最后一行，定義了默認(rèn)啟動(dòng)腳本。這個(gè)腳本負(fù)責(zé)監(jiān)聽(tīng)，啟動(dòng)部署。如何使用這個(gè)項(xiàng)目已經(jīng)放到了和上。 API Blueprint 上次介紹的 API Blueprint 解決方案 雖然不錯(cuò)，但是有一些問(wèn)題： 部署麻煩，需要裝不少東西 文檔更新后不支持自動(dòng)部署 沒(méi)有權(quán)限控制 以...

    dreamGong 評(píng)論0 收藏0

  • 試探API Blueprint接口文檔生成和接口模擬

    前言 今天發(fā)現(xiàn)了一個(gè)很niubility的東西__API Blueprint__,先給出官網(wǎng)https://apiblueprint.org/。下面是官網(wǎng)給出的介紹： API Blueprint. A powerful high-level API description language for web APIs. 這個(gè)可以干什么呢？按照API Blueprint的語(yǔ)法(類(lèi)似markdown)，...

    mist14 評(píng)論0 收藏0

  • justreq與mock.js組合，快速打造高質(zhì)量Mock Server

    摘要：而則是主要用于接口緩存的一款。初始化完成后，將在當(dāng)前目錄生成文件。其它未在規(guī)則中的請(qǐng)求，將直接代理并緩存下來(lái)，而不進(jìn)行轉(zhuǎn)發(fā)。每條記錄包含和兩個(gè)屬性，并且也是隨機(jī)自動(dòng)生成的。 概述 搜到這篇文章之前，相信你已對(duì)Mock Server及mock.js有一定的了解。簡(jiǎn)單概括，Mock Server即模擬服務(wù)器，用于模擬后端api服務(wù)。mock.js是國(guó)內(nèi)的高云開(kāi)發(fā)的一款json數(shù)據(jù)生成器，主...

    Awbeci 評(píng)論0 收藏0

發(fā)表評(píng)論

0條評(píng)論

最新活動(dòng)
閱讀需要支付1元查看
<