fairy-slipper 0.2.0

功能

• 将WADL源迁移到扩展文件
• 在web浏览器中显示rst plus swagger json文件

开发

首先运行migrate脚本以最初从wadl迁移内容：

./migrate.sh

此脚本将签出文档的当前版本。

要运行Web服务器，请使用：

./run_server.sh

然后，一个基于山核桃的web服务器将监听http://127.0.0.1:8080

grunt

目录结构（未来）

当前文档输出布局：

api-doc/ -- the root of the documentation
api-doc/index.json  -- the index file that lists all the files that are included in the API doc.
api-doc/<service>/<version>.rst
api-doc/<service>/<version>/<request_schema>.json
api-doc/<service>/<version>/<response_schema>_<status_code>.json
api-doc/<service>/<version>/examples/<request>_req.json
api-doc/<service>/<version>/examples/<response>_resp_<status_code>.json
conversion_files_valid/<service-version>.json -- valid Swagger files

其他招摇用户界面

取自https://github.com/swagger-api/swagger-spec/wiki/Sites-and-Services

• http://docs.apimatic.apiary.io/
• http://docs.api2cart.com/post/interactive-docs
• http://chat.banckle.com/api/v3.0/
• http://www.evercam.io/develop/docs
• https://api.elastic.io/docs/
• https://developer.concur.com/
• https://www.callfire.com/api-documentation/rest/version/1.1
• https://www.bitmex.com/api/explorer/
• https://bitdango.com/api
• https://api.groupdocs.com/v2.0/spec/
• http://developer.wordnik.com/docs.html
• https://api.sensr.net/doc/v3/index.html

其他API文档工具

• https://github.com/danielgtaylor/aglio

替代客户

• https://github.com/Orange-OpenSource/angular-swagger-ui
• https://github.com/apigee-127/swagger-client-API
• https://github.com/signalfx/swagger-ajax-client/
• https://github.com/signalfx/swagger-angular-client
• https://github.com/signalfx/swagger-client-generator

其他有用的工具

• http://jsonschema.net/