## 一、概述 PI Blueprint 是一套基于 markdown 的 API 描述语言规范，如果你按照它的规范来编写你的 API 文档的话，你就可以享受到配套的工具服务了； 它基于markdown语法，跟knife4j(swagger）是竞争关系； [aglio](https://link.jianshu.com/?t=https://github.com/danielgtaylor/aglio)是一个可以根据 api-blueprint 的文档生成静态 HTML 页面的工具。 ## 二、安装 ``` npm install -g aglio aglio -i foo.md -o bar.html ``` ## 二、实战 ``` FORMAT: 1A # Example API hello world ## 消息 [/messages] ### 获取消息 [GET] + Response 200 (application/json) { "hello": "world" } ``` 生成html文档： ``` aglio -i hello.md -o hello.html ``` 启动服务： ``` api-mock ./hello.md --port 3000 ``` 访问`localhost:3000/message` 不但有了漂亮的 html 文档, 也有了一个方便对接的 mock 服务.；