Swagger學習

Swagger

主要看源碼學習

導入依賴

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
    <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger2</artifactId>
      <version>2.9.2</version>
    </dependency>
    <!-- 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>
           

swagger版本 3.0.0 與2.9.2 有些許的不同，如：通路swagger-ui.html的位址不同

配置swagger

package com.example.demo.config;


import com.google.common.base.Predicate;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.RequestHandler;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.VendorExtension;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;

@EnableSwagger2
@Configuration
public class SwaggerConfig {
	@Value("${isActive}")
	boolean isActive;
	@Bean
	public Docket d1(){

		System.out.println("是否開啟: "+isActive);
		return new Docket(DocumentationType.SWAGGER_2)
			.groupName("王順")//分組的名字
			.enable(isActive)//是否能夠進入swagger.ui
			.apiInfo(a1())//描述資訊
			.host("8089")
			.select()
//			指定選擇包下面的
			.apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
//			掃描某個接口下的。。。。。
//			.paths(PathSelectors.ant("/user/**"))
			.build();
	}

	public ApiInfo a1(){
		return new ApiInfo(
			"題目",
			"描述",
			"test1.0",
			"termsOfServiceUrl",
			new Contact("contactName", "www.baidu.com", "[email protected]"),
			"license",
			"licenseUrl",
			new ArrayList<VendorExtension>()
		);
	}
}

           

根據不同的環境決定是否開啟swaggerui

由于環境的不同可以使用注解@Value擷取配置檔案中.yml中的值決定是否開啟；

在swaggerUI中顯示注釋

• Api 【可以用于所有】
  • ApiModel(“實體名字”) 【用于實體class上的注釋】【隻有有傳回這個類型的時候swaggerUI中才會出現】
  • ApiModelProperty(“屬性名字”)【用于實體屬性的注釋】
  • ApiOperation(“接口名字”)【用于接口的注解】
  • ApiParam(“接口參數名字”)【用于接口上參數的注釋】