Swagger @Info 注解用于提供 API 文档的基本信息,例如标题、描述、版本等信息。
示例:
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.controller"))
.paths(PathSelectors.any())
.build()
.apiInfo(apiInfo());
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("My API")
.description("API documentation for my project")
.version("1.0.0")
.build();
}
}
在这个例子中,@Info 注解用于创建一个 ApiInfo 对象,其中包含了 API 文档的基本信息,例如标题、描述、版本等。这些信息可以在 Swagger UI 界面中显示,帮助用户快速了解 API 的基本情况。在 Docket 中使用 apiInfo() 方法将 ApiInfo 对象与 Docket 关联起来,以便在 Swagger UI 界面中显示 API 文档的基本信息。