API BluePrint

API设计软件

API BluePrint

语法规范

• 首先, 可以查看官方提供的例子 . 一共也就 10 多个, 想深究的童鞋可以看一下。

• 然后是很大概率用不太到的语法规范。

• MSON语法规范，基本用不太到。

配套工具

编辑器插件

对于不熟悉语法的童鞋，建议安装预览插件，相当于即时检查。从👇选一个顺手的吧！
* sublime

* atom-language

* atom-preview

* vim

Mock 服务

这个是用来根据大家撰写的api.md来生成对应假数据的，理论上大家不需要安装，想体验一把的可以试试。
* api-mock
* drakov

npm install -g api-mock
api-mock api.md --port 3000
npm install -g drakov
drakov -f api.md -p 3000

静态 HTML 生成

写了一堆 markdown 文档，到了该出成果的时候了。使用aglio来生成我们需要的html页面吧。

安装与使用都非常简单，首先要确保本地装有 node 环境。

npm install -g aglio
aglio -i api.md -o api.html
此时你可以选择打开api.html预览。但这个命令更多是给服务端生成页面用的。不太常用。
可以直接：
aglio -i api.md -s 
然后通过 http://127.0.0.1:3000就可以预览所生成的文件啦，这个这个页面在修改文档时是可以同步刷新的😄

生成html文件时可能会报错，blueprint有点类似于yaml语法，需要严格遵循语法定义（主要是空格的数量及换行约定）。错误会包含行号，请注意排查。😢，这么重要的东西，是不是应该放到顶部？