进行前后端开发时，经常会有这样的需求：“你定义接口了吗？能不能帮我启动一个MockServer并运行起来第一的？”那么，如何避免前后端开发在时差上不必要的等待呢？api-blueprint或许就是你想要的福音。APIBlueprint是一套API描述标准。与Markdown一样，它是一种标记语言，可以将标记文档转换为漂亮的界面文档。您还可以创建用于本地调试的模拟服务器。1.语法只要你写过markdown的东西，基本可以很快掌握APIBlueprintLanguage的语法。总共有10多个官方示例。耐心看完，心里大概就会明白；语法规范；官方解释器，有了这个解析器，可以很方便的扩展自己的相关工具（比如代码生成等）2.Mockserverapi-mockdrakov两者都可以根据api-blueprint的文档创建本地的mockserver。安装和使用都很简单，选择其中一个安装即可，并确保安装了本地的node环境：$node-v可以获取到版本号，如：v6.5.0，直接安装mock即可工具，如果没有，请谷歌并自己安装一个。2.1工具一：安装api-mock$npminstall-gapi-mock启动mockserver，方法中的api.md为所需服务器的api-blueprint文件名&api-mock./api.md--port30002.2工具二：安装drakov$npminstall-gdrakov启动mockserver，方法中的api.md为所需服务器的api-blueprint文件名$drakov-fapi.md-p3000三、生成staticHTMLaglio是一个可以基于api-blueprintdocumentation工具生成静态HTML页面的api。aglio不是简单的markdown到html的转换，而是可以生成类似rdoc的特定格式和样式的查询文档。3.1安装确保安装本地节点环境：$npminstall-gaglio3.2生成HTML$aglio-iapi。md-oapi.html4.创建本地调试的statistics.md文件，输入以下内容：FORMAT:1A#ExampleAPIstatistics##Statistics[/statistics]###获取统计数据[GET]+Response200(application/json){"success":true,"err_code":"888888","err_msg":"错误描述","data":[{"hour":"2016-10-31","totalIncome":"1000.09","totalRefund":"100.08","incomeOrders":70,"refundOrders":10,"totalOrders":80}]}4.1生成HTML文档$aglio-istatistics.md-ostatistics.html点击即可view4.2创建mock服务端安装的mock工具是drakov。创建模拟服务的命令行如下：$drakov-f./statistics.md-p3000如果你安装了api-mock：$api-mock./statistics.md--port3000当一切都完成后，你可以访问http://localhost:3000/statistics，发送网络请求获取数据，无需等待，前后端同步，nice。参考文档UsingAPI-BlueprinttoWriteAPIDocumentationapiblueprintGenerateElegantRESTfulAPIDocumentationwithAPIblueprintAPIBlueprintDockerAPIBlueprintAPIBlueprintGuideGenerateElegantRESTfulAPIDocumentationwithAPIblueprint
