Swagger學習（四、配置API文檔的分組）

 

 

 

 

---

 

完整示例

代碼結構                                                                                              

   

運行效果

 

 

 

SwaggerConfig.class

@Configuration   //變成配置文件
@EnableSwagger2  //開啟swagger2
public class SwaggerConfig {
    @Bean
    public Docket docket01(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("灑家");
    }
    @Bean
    public Docket docket02(){
        return new Docket(DocumentationType.SWAGGER_2)
                .groupName("白水煮開一切");
    }
    @Bean  //配置swagger的docket的bean實例
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("孤下")
                .enable(true)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.kuang.swagger.controller"))
                .build();
    }
    //配置swagger信息的ApiInfo
    private ApiInfo apiInfo(){
        //作者的聯系方式
        Contact contact = new Contact("xiaowei","https://www.baidu.com","[e-mail]");
        return new ApiInfo(
                "xiaowei hello",
                "有一種想見不敢見的傷痛 有一種愛還埋藏在我心中",
                "v0.1",
                "ttps://www.baidu.com",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList()
        );
    }
}

 

HelloController.class

@RestController
public class HelloController {
    @GetMapping(value = "/hello")
    public String hello(){
        return "hello swagger";
    }
    @ApiOperation("hello2 的get請求的注釋")
    @GetMapping(value = "/hello2")
    public String hello2(String username){
        return "hello"+username;
    }
    //只要我們的接口中，返回值中存在實體類，他就會被掃描到swagger中
    @PostMapping(value = "/user")
    public User user(){
        int i=5/0;
        return new User();
    }
    @ApiOperation("user2 的post請求的注釋")
    @PostMapping(value = "/user2")
    public User user2(@ApiParam("用戶名") User user){
        return user;
    }
}

 

User.class

@ApiModel("用戶實體類")
public class User {
    @ApiModelProperty("用戶名")
    public String username;
    @ApiModelProperty("密碼")
    public String password;
}