简介
号称:世界最流行的API框架
解决什么问题:在前后台分离的开发模式中,减小接口定义沟通成本,方便开发过程中测试,自动生成接口文档。
实例代码位置:https://github.com/123xiao/swagger
swagger使用方式
第一种
定义YAML文件,然后可以生成各种语言的代码框架,对于后台程序员来说,较少人会愿意写出一堆YAML格式。
第二种
swagger有各种语言的插件,可以通过配置及少量代码,生成接口文档及测试界面。
我们多做了:一次性的配置及少量注解代码。
我们不用再做:1、到Wiki中更新接口文档;2、Postman形式的测试;3、Curl形式的测试
swagger java使用介绍
对于一个SpringMVC项目,使用swagger的配置如下:
pom.xml
1 | <!-- Swagger --> |
SwaggerConfiguration.java
1 |
|
SwaggerWebMvcConfigurerAdapter.java
1 |
|
Controller实例
然后,只要在我们的Controller里面增加注解 ApiOperation和ApiParam 即可。
1 | "TbAccountControllerApi", description = "账户管理接口相关api描述", hidden = true, position = 1) (tags = |
Web界面
启动项目,输入Http://Path/swagger-ui.html,就可以给前端展示相关的API文档,并像使用Postman以及Curl命令一样,通过Web界面进行接口测试。