SpringBoot+Swagger_UI怎么配置

本篇内容主要讲解“Spring Boot+Swagger_UI怎么配置”，感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷，实用性强。下面就让小编来带大家学习“Spring Boot+Swagger_UI怎么配置”吧!

在东丰等地区，都构建了全面的区域性战略布局，加强发展的系统性、市场前瞻性、产品创新能力，以专注、极致的服务理念，为客户提供成都网站建设、网站设计网站设计制作按需设计网站,公司网站建设,企业网站建设,成都品牌网站建设,全网营销推广,外贸网站制作,东丰网站建设费用合理。

一：pom.xml 依赖

		
			io.springfox
			springfox-swagger2
			2.8.0
		
		
			io.springfox
			springfox-swagger-ui
			2.8.0

二：application.yaml 开关配置

# swagger
swagger: 
  switch: true

三：SwaggerConfig.java 配置

@Configuration
@EnableSwagger2
public class SwaggerConfig {
	@Value("${swagger.switch}")
	private boolean swaggerSwitch;
	@Bean
	public Docket createRestApi() {
		Docket docket = new Docket(DocumentationType.SWAGGER_2);
		if (swaggerSwitch) {
			docket.enable(true);
		} else {
			docket.enable(false);
		}
		docket.apiInfo(apiInfo()).select()
				// 加了ApiOperation注解的类，才生成接口文档
				.apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
				// 包下的类，才生成接口文档
				.paths(PathSelectors.any()).build().securitySchemes(security());
		return docket;
	}
	private ApiInfo apiInfo() {
		return new ApiInfoBuilder().title("Demo").description("接口文档").termsOfServiceUrl("").version("0.1").build();
	}
	private List security() {
		return newArrayList(new ApiKey("token", "token", "header"));
	}
}

四：接口配置代码示例

/**
	  * @Title: list
	  * @Description: 测试
	  * @return void    返回类型
	  * @throws
	  */
	@ApiOperation(value="消息列表查询",notes="消息列表查询")
	@ApiImplicitParams({@ApiImplicitParam(name="userId",value="用户ID",required=true,dataType="int")})
	@ApiResponses(value= {@ApiResponse(code = 200,message="Sucess",response=MsgPushInfoEntity.class,responseContainer="List")})
	@RequestMapping(value="/list",method=RequestMethod.POST)
	public List list(@RequestBody MsgPushInfoEntity msg) {
		logger.info("===========" + msgPushInfoService.list().size() + "===========");
		logger.error("===========" + msgPushInfoService.list().size() + "===========");
		return  new ArrayList();
	}

五：swagger-ui展示

Spring Boot+Swagger_UI怎么配置

六：Swagger注解说明

1.@Api

该注解将一个Controller（Class）标注为一个swagger资源（API）。在默认情况下，Swagger-Core只会扫描解析具有

@Api注解的类，而会自动忽略其他类别资源（JAX-RS endpoints，Servlets等等）的注解。该注解包含以下几个重要属性：

大橙子网站建设，新征程启航

SpringBoot+Swagger_UI怎么配置

其他资讯