分组和接口注释

最新推荐文章于 2024-11-01 14:48:20 发布

Massimo_ycw

最新推荐文章于 2024-11-01 14:48:20 发布

阅读量103

点赞数

分类专栏： SpringBoot 文章标签： java

本文链接：https://blog.csdn.net/Massimo__JAVA/article/details/127831884

版权

SpringBoot 专栏收录该内容

37 篇文章 2 订阅

订阅专栏

一、配置API文档的分组

沿用上一篇博客项目

groupName()

@Bean
    public Docket docket(Environment environment){

        //设置要显示的Swagger环境
        Profiles profiles = Profiles.of("dev", "test");
        //通过environment.acceptsProfiles()判读是否处在自己设定的环境中
        boolean flag = environment.acceptsProfiles(profiles);

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("Massimo")
                //enable(),是否启动Swagger，默认为true，如果为false，则Swagger不能在浏览器中访问
                .enable(flag)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.massimo.swagger.controller"))
                .build();
    }

效果：
在这里插入图片描述

二、配置多个分组

创建多个Docket实例

@Bean
    public Docket docket1(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("A");
    }

    @Bean
    public Docket docket2(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("B");
    }

    @Bean
    public Docket docket3(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("C");
    }

效果：
在这里插入图片描述

三、实体类配置

3.1、创建实体类

package com.massimo.swagger.pojo;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;

@ApiModel("用户实体类") //等价于@Api(注释)
public class User {

    @ApiModelProperty("用户名")
    public String username;
    @ApiModelProperty("密码")
    public String password;
}

3.2、Controller

//只要我们的接口中，返回值存在实体类，他就会被扫描到swagger中
    @PostMapping(value = "/user")
    public User user(){
        return new User();
    }

效果：
在这里插入图片描述

四、接口配置

4.1、Controller

@RestController
public class HelloController {

    @GetMapping(value = "/hello")
    public String hello(){
        return "hello";
    }

    //只要我们的接口中，返回值存在实体类，他就会被扫描到swagger中
    @PostMapping(value = "/user")
    public User user(){
        return new User();
    }

    //Operation接口
    @ApiOperation("Hello控制类")
    @GetMapping(value = "/hello2")
    public String hello2(@ApiParam("用户名") String username){
        return "hello" + username;
    }

    @ApiOperation("Post测试")
    @PostMapping(value = "/postt")
    public User postt(@ApiParam("用户") User user){
        int i = 1/0;
        return user;
    }
}