注解
最常用注解
@Tag 作用在Controller 类上
@Operation 作用在 Controller 方法上
@Schema: 作用在DTO、DO、VO属性上
常用注解
注解 标注位置 作用
@Tag Controller类 标识Controller作用
@Parameter 参数 标识参数作用
@Parameters 参数 参数多重说明
@Schema model层的JavaBean 描述模型的作用及每个属性
@Operation 方法 描述方法作用
@ApiResponse 方法 描述响应状态码
例子:
config配置类
package com.atguigu.cloud.config;
import io.swagger.v3.oas.models.ExternalDocumentation;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import org.springdoc.core.models.GroupedOpenApi;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
@Configuration
public class Swagger3Config {
/**
* 模块分组
* @return
*/
@Bean
public GroupedOpenApi PayApi()
{
return GroupedOpenApi.builder().group("支付微服务模块").pathsToMatch("/pay/**").build();
}
@Bean
public GroupedOpenApi OtherApi()
{
return GroupedOpenApi.builder().group("其它微服务模块").pathsToMatch("/other/**", "/others").build();
}
/*@Bean
public GroupedOpenApi CustomerApi()
{
return GroupedOpenApi.builder().group("客户微服务模块").pathsToMatch("/customer/**", "/customers").build();
}*/
/**
* 文档描述
* @return
*/
@Bean
public OpenAPI docsOpenApi()
{
return new OpenAPI()
.info(new Info().title("cloud2024")
.description("通用设计rest")
.version("v1.0"))
.externalDocs(new ExternalDocumentation()
.description("个人博客")
.url("https://blog.csdn.net/JEREMY_GYJ"));
}
}