概述
之前开发项目的时候,需要写API文档,项目小接口少的时候一份word就能简单应付,但是随着项目的API的增加,对API文档的维护工作就会越来越繁琐,为此引入能自动生成RESTful接口文档的Swagger2框架就变得理所当然。
作为一个能够自动生成API文档的框架,其最大的优点有两个:
- 接口文档在线能够自动生成,文档随接口变动实时更新,节省维护成本
- 支持类似spring RESTful插件那样的在线接口测试,不依赖第三方工具
一、举个例子?
假设现在有一个TestController接口,里面有几个简单的API,通过swagger的注解添加接口描述
1 |
|
启动项目后访问特定页面即可看到以Controller分类的API文档,点击展开以,根据注解的详细程度,会有传入参数,返回类型等详细说明,除此之外,还会有类似springREST插件那样的在线测试功能