如何编写swagger配置类
时间: 2023-08-03 17:05:55 浏览: 169
在使用Swagger来生成API文档时,你需要编写Swagger配置类来定义API的基本信息、请求参数、响应模型等。下面是一个使用Java编写Swagger配置类的示例:
```java
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
@Configuration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.select()
.apis(RequestHandlerSelectors.basePackage("your.package.name"))
.paths(PathSelectors.any())
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("Your API Title")
.description("Your API Description")
.version("1.0.0")
.build();
}
}
```
在上面的示例中,我们使用了Springfox框架来集成Swagger。`@Configuration`注解表示该类是一个配置类,`@EnableSwagger2`注解表示启用Swagger。
`@Bean`注解用于创建一个`Docket`实例,用于配置Swagger的基本信息。在`Docket`的构造方法中,我们指定了Swagger的版本为2.0,并使用`.apiInfo()`方法来配置API的基本信息,如标题、描述和版本号。
`.select()`方法用于指定要生成API文档的接口所在的包路径,通过`.apis(RequestHandlerSelectors.basePackage("your.package.name"))`来设置。
`.paths(PathSelectors.any())`表示选择所有的接口路径生成API文档。
最后,使用`.build()`方法来构建`Docket`实例。
你可以根据自己的项目需求修改上述示例代码中的配置信息,然后将该配置类添加到你的项目中,即可生成Swagger API文档。
阅读全文