整合Swagger接口文档

Swagger接口文档：自动生成接口文档
1.添加依赖：

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger-ui</artifactId><version>2.9.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency><groupId>io.springfox</groupId><artifactId>springfox-swagger2</artifactId><version>2.9.2</version>
</dependency>

2.添加配置

swagger:title: xxx项目RESTful APIdescription: 开发人员太懒，没有写描述version: 1.0contactName: lxtcontactEmail:contactUrl:basePackageRest: com.qcby.xxx.resttermsOfServiceUrl:

3.建一个properties包，建一个Swagger类

@Component
@ConfigurationProperties(prefix = "swagger")
public class SwaggerProperties {private String title;private String contactName;private String contactUrl;private String contactEmail;private String version;private String description;private String basePackageRest;private String termsOfServiceUrl;.... get  set方法
}

4.在config里创建SwaggerConfig配置类

@Configuration
@EnableSwagger2
public class SwaggerConfig {@Autowiredprivate SwaggerProperties swaggerProperties;@Beanpublic Docket createRestApi() {return new Docket(DocumentationType.SWAGGER_2).groupName("REST接口").apiInfo(apiInfo()).select()//  配置自动扫描那些包下类型生成接口文档.apis(RequestHandlerSelectors.basePackage(swaggerProperties.getBasePackageRest())).build();}//构建 api文档的详细信息函数,注意这里的注解引用的是哪个private ApiInfo apiInfo() {return new ApiInfoBuilder()//页面标题.title(swaggerProperties.getTitle())//创建人.contact(new Contact(swaggerProperties.getContactName(), swaggerProperties.getContactUrl(),swaggerProperties.getContactEmail()))//版本号.version(swaggerProperties.getVersion())//描述.description(swaggerProperties.getDescription()).build();}
}

注意：
1.

如果我们不给controller层的接口加get、post请求方法，那么会出现这么一种情况：

一个方法会有多种请求方式，当接口非常多的时候就会很多，所以我们需要加上请求方法，post方法：@Postmapping
get、post方法：@RequestMapping(method = {RequestMethod.GET, RequestMethod.POST})

整合Swagger接口文档相关推荐

sentinel 官方文档_SpringCloud网关聚合Swagger接口文档实践
目前大多数项目都是以微服务架构设计,以前后端分离技术解耦前端开发工程师和后端开发工程师的工作量,这样一来前后端的对接将是一项重要的沟通工作量,如果后端没有一个合适的API文档,那么这样的前后端对接将是 ...
SpringBoot集成knife4j实现Swagger接口文档
前言:如果你是后台开发,提供restful接口给前端,建议你使用Swagger3提供restful的接口文档自动生成和在线接口调试.knife4j是对Swagger进一步封装,其优化了API文档的UI ...
【SpringBoot】22、SpringBoot中整合knife4j接口文档
在项目开发中,web项目的前后端分离开发,APP开发,需要由前后端工程师共同定义接口,编写接口文档,之后大家都根据这个接口文档进行开发,到项目结束前都要一直维护接口文档使得项目开发过程中前后端工程师 ...
swagger接口文档使用
swagger接口文档一,swagger简介前后端分离 swagger 诞生二,springboot集成swagger 依赖编写helloworld接口配置swagger ==> co ...
springboot 接口文档请求 enum_Spring Boot集成SpringFox 3：生成Swagger接口文档
SpringFox介绍 SpringFox是一个开源的API Doc的框架, 它的前身是swagger-springmvc,可以将我们的Controller中的方法以文档的形式展现.官方定义为:Aut ...
自动生成python接口文档_Django自动生成Swagger接口文档
Django自动生成Swagger接口文档 1. 前言当接口开发完成,紧接着需要编写接口文档.传统的接口文档通常都是使用Word或者一些接口文档管理平台进行编写,但此类接口文档维护更新比较麻烦,每次 ...
swagger接口文档出现的空文档问题
记一次使用swagger接口文档出现的空文档问题问题描述: 上面显示的一些空文档下面的才是真正的正确文档: 最终尝试发现问题: 原因:**@Api(value = "ExamPaperC ...
python实现处理swagger接口文档，转换为yaml格式的自动化用例
前言之前有很多小伙伴反馈,希望我出一期将swagger文档转换为 yaml格式的自动化用例,那么本期福利来咯~~这一篇文档,将会带领你们实现如何通过 swagger文档转换为 yaml格式的用例 ...
Python Swagger 接口文档自动集成平台
一安装当前virtualenv 环境下 pip install django-rest-swagger==2.2.0 在Django项目settings.py中加入插件模块 DEBUG = T ...

整合Swagger接口文档

整合Swagger接口文档相关推荐

最新文章

热门文章