文章资料-情感.机器.认知-电子AI 游客
项目API文档在线自动生成 Swagger UI
【8661】by12016-07-25 2017-05-04 最后编辑2019-01-10 22:00:10 浏览967

 Swagger UI是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。

       现在多数的项目开发中,网站和移动端都需要进行数据交互和对接,这少不了使用REST编写API接口这种场景。例如有些团队,移动端交由了另一团队开发,不同开发小组之间就需要以规范和文档作为标准和协作基础。良好的文档可以让开发事半功倍,而作为又懒又要效率又能交代的码农,当然最希望一 切自动化,或用小聪明来找到最适合的工具。

       Swagger-UI简单而一目了然。它能够纯碎的基于html+javascript实现,只要稍微整合一下便能成为方便的API在线测试工具。

       项目的设计架构中一直提倡使用TDD(测试驱动)原则来开发,swagger-ui在这方面更是能提供很大帮助。 Swagger-UI更倾向于在线测试接口和数据,但其核心是一个javascript插件,只要稍作修改,便能按需求定制出不同格式的说明文档,在github上更是基于它集成到各种语言环境,分支众多。 

       其官方提供了一个离线版本,它的使用方法十分简单:直接在js格式的资源文件中录入REST API的json信息,便能容易地生成不同模块下的API列表,每个API接口描述和参数、请求方法都能在每个json数组中定制。


下面是目前项目中使用到的部分预览图: 

Swagger-UI 的官方地址: 

http://swagger.wordnik.com

Github上的项目地址: 

https://github.com/wordnik/swagger-ui

官方提供的demo地址 

http://petstore.swagger.wordnik.com/


Swagger UI

关于Swagger UI官方解释是这样的:The Swagger UI is an open source project to visually render documentation for a Swagger defined API directly from the API’s Swagger specifcation 官网地址 
下面是官方的效果图: 
文档效果图
我将上图分成了两部分