Swagger快速上手和使用

目录Swagger简介SpringBoot集成SwaggerSwagger配置常用注解Swagger简介号称世界上最流行的API框架Restful Api 文档在线自动生成器 API 文档 与API 定义同步更新直接运行在线测试API官网https://swagger.io/SpringBoot集成Swagger导jar包!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --dependencygroupIdio.springfox/groupIdartifactIdspringfox-swagger2/artifactIdversion2.9.2/version/dependency!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui --dependencygroupIdio.springfox/groupIdartifactIdspringfox-swagger-ui/artifactIdversion2.9.2/version/dependency开启swaggerConfiguration//配置类EnableSwagger2// 开启Swagger2的自动配置publicclassSwaggerConfig{}访问路径http://localhost:8080/swagger-ui.htmlswagger界面Swagger配置配置文档信息Configuration//配置类EnableSwagger2// 开启Swagger2的自动配置publicclassSwaggerConfig{//配置文档信息BeanpublicDocketdocket(){returnnewDocket(DocumentationType.SWAGGER_2)//配置文档信息swagger信息.apiInfo(apiInfo());//配置扫描接口信息只会扫描controller的方法生成接口文档普通的类的方法不会扫描.select()// 通过.select()方法去配置扫描接口,RequestHandlerSelectors配置如何扫描接口.apis(RequestHandlerSelectors.basePackage(com.kuang.swagger))// 配置如何通过path过滤,即这里只扫描请求以/kuang开头的接口.paths(PathSelectors.ant(/kuang/**))//一般PathSelectors.any() s扫描所有接口也可以不配置.paths()方法.build();}}//配置文档信息privateApiInfoapiInfo(){ContactcontactnewContact(联系人名字,http://xxx.xxx.com/联系人访问链接,联系人邮箱);returnnewApiInfo(Swagger学习,// 标题学习演示如何配置Swagger,// 描述v1.0,// 版本http://terms.service.url/组织链接,// 组织链接contact,// 联系人信息Apach 2.0 许可,// 许可许可链接,// 许可连接newArrayList()// 扩展);}常用注解Api(tags “xxx模块说明”)作用在controller类上ApiOperation(“xxx接口说明”)作用在controller接口方法上ApiModel(“xxxPOJO说明”)作用在模型类上如VO返回值实体类、DTO参数实体类ApiModelProperty(value “xxx属性说明”,hidden true)作用在模型类属性上hidden设置为true可以隐藏该属性ApiParam(“xxx参数说明”)作用在controller接口方法参数上注意尽量不要使用注解name属性别误导前端发错参数名