Swagger的简单配置

swagger配置

• swagger的jar包

• <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>
  

• swagger的Bean实例Docket；

• 创建config包 在里面创建class文件

• @Configuration
  @EnableSwagger2
  public class SwaggerConfig {
  }
  

• 配置了Swagger的bean 的实例

• @Bean
  public Docket docket(Environment environment){
      //设置swagger要显示的环境
      Profiles profiles=Profiles.of("env","test");
      //获取profiles文件，判断是否处在自己设定的环境中
      boolean flag=environment.acceptsProfiles(profiles);
      return new Docket(DocumentationType.SWAGGER_2)
          //个人配置ApiInfo
          .apiInfo(apiInfo())
          .enable(flag)//是否启动swagger，为false 则不能访问
          .select()
          //扫描com.dfejis.swagger.controller下的文件
          .apis(RequestHandlerSelectors
          .basePackage("com.dfejis.swagger.controller")).build();
      }
  

• 配置ApiInfo
  

Swagger的实体类注解

@ApiModel("用户类")
public class User {
    @ApiModelProperty("名字")
    private String name;
	 private String password;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public String getPassword() {
        return password;
    }
    public void setPassword(String password) {
        this.password = password;
    }
}

Controller类

@RestController
public class HelloController {
    @GetMapping("/hello")
    public String Hello(){
        return  "hello";
    }
    //Api的注解
    @ApiOperation("用户类")
    @PostMapping("/user")
    public User user(String name) {
        return new User();
    }
}

Swagger的多分组

@Bean
public Docket docket1(Environment environment){}
@Bean
public Docket docket2(Environment environment){}

Swagger的访问路径

http://localhost:8080/swagger-ui.html

​ 前台页面