swagger配置

最新推荐文章于 2024-11-19 14:38:25 发布

面壁人

最新推荐文章于 2024-11-19 14:38:25 发布

阅读量155

点赞数

CC 4.0 BY-SA版权

分类专栏： ssm 文章标签： swagger

本文链接：https://blog.youkuaiyun.com/weixin_42778181/article/details/82656410

ssm 专栏收录该内容

2 篇文章

订阅专栏

本文介绍如何使用Swagger自动生成API文档并进行请求测试。通过在Maven项目中引入相关依赖，配置SwaggerConfig类来实现API文档的生成。最终可以通过访问特定URL查看生成的文档。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

swagger是用来自动生成api文档的工具，还能兼测试请求的工具
首先在maven中导入以下依赖

<dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger2</artifactId>
      <version>2.4.0</version>
    </dependency>
    <dependency>
      <groupId>io.springfox</groupId>
      <artifactId>springfox-swagger-ui</artifactId>
      <version>2.4.0</version>
    </dependency>
    <dependency>
      <groupId>com.google.guava</groupId>
      <artifactId>guava</artifactId>
      <version>19.0</version>
    </dependency>
    <dependency>
      <groupId>org.mapstruct</groupId>
      <artifactId>mapstruct-jdk8</artifactId>
      <version>1.1.0.Final</version>
    </dependency>
    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-core</artifactId>
      <version>2.8.7</version>
    </dependency>
    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-databind</artifactId>
      <version>2.8.7</version>
    </dependency>
    <dependency>
      <groupId>com.fasterxml.jackson.core</groupId>
      <artifactId>jackson-annotations</artifactId>
      <version>2.8.7</version>
    </dependency>

创建一个swagger-config用来配置信息

@Configuration// 写了applicationContext-mybatis.xml
@ComponentScan(basePackages="controller") // <context-ComponentScan basepackage="xxx.xx.x.xx">
@EnableSwagger2//启动swaggerapi生成
public class SwaggerConfig extends WebMvcConfigurationSupport{
    @Bean// <bean id="apiGen" class="Docket"/>

    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.any())
                .paths(PathSelectors.any())
                .build();

    }
    /**
     * 创建该Api的基本信息（这些基本信息会展现在文档页面中）
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("这是标题")
                .termsOfServiceUrl("")
                .contact("这是小组")
                .version("这是版本")
                .build();
    }
}