码迷,mamicode.com
首页 > 其他好文 > 详细

自动生成swagger 前后端分离 对接文档

时间:2020-12-02 12:35:15      阅读:6      评论:0      收藏:0      [点我收藏+]

标签:vat   配置   builder   就是   添加   pre   需要   build   group   

0.0首先  材料准备+环境介绍

环境是springboot  分模块开发,有很多模块是跑web服务器,但是大家都会共同依赖一个基础模块 common模块 

如下2个材料就是配置在 common模块中,供各个跑web服务器的模块都可以使用到

 

如下是spring boot的自动配置类,       KnifeConfiguration

放在 common模块的config包内,这是一个自定义自动配置类

/**********************************************************************************************************************************************************************/

import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import;
import springfox.bean.validators.configuration.BeanValidatorPluginsConfiguration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
@EnableKnife4j
@Import(BeanValidatorPluginsConfiguration.class)
public class KnifeConfiguration {

@Bean
public Docket buildDocket() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(buildApiInfo())
.select()
// 要扫描的API(Controller)基础包
.apis(RequestHandlerSelectors.basePackage("com.biyou"))
.paths(PathSelectors.any())
.build();
}

private ApiInfo buildApiInfo() {
Contact contact = new Contact("主标题","","");
return new ApiInfoBuilder()
.title("测试平台-平台管理API文档")
.description("平台管理服务api")
.contact(contact)
.version("1.0.0").build();
}
}
/**********************************************************************************************************************************************************************/

材料2 需要在commoon模块的pom文件中添加如下依赖

<!-- swagger2 -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
<!-- knife4j -->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>2.0.2</version>
</dependency>

/*@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@*/
这样安排好了后
某个web项目跑起来了以后

好比说这个web项目的的服务端口号是9011

我在访问 http://localhost:9011/doc.html 网页就可以看到这个web项目需要的前后端对接的 swagger 文档


 

自动生成swagger 前后端分离 对接文档

标签:vat   配置   builder   就是   添加   pre   需要   build   group   

原文地址:https://www.cnblogs.com/cjd01/p/14051571.html

(0)
(0)
   
举报
评论 一句话评论(0
登录后才能评论!
© 2014 mamicode.com 版权所有  联系我们:gaon5@hotmail.com
迷上了代码!