Swagger 快速撰写接口文档

最新推荐文章于 2024-04-13 09:59:25 发布

原创最新推荐文章于 2024-04-13 09:59:25 发布 · 221 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#开发语言 #java #前端框架 #前端 #vue.js

博主记录Swagger简单使用过程，包括在application.properties加入配置、在pom.xml加入依赖、创建config - SwaggerConfig。但因高版本idea可能与swagger冲突，且写入依赖时会飘红，需刷新maven解析。最后swagger在项目中一直报错，博主无奈删掉并求助。

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

学习到Swagger简单使用了，记录一下

在 application.properties 加入配置

由于高版本idea可能与swagger产生冲突，需要加入下面的配置：

spring.mvc.pathmatch.matching-strategy=ant_path_matcher

pom.xml 加入依赖

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>3.0.0</version>
</dependency>

    <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>3.0.0</version>
</dependency>

刚写入会飘红一段时间，刷新maven就会解析依赖

创建config-SwaggerConfig

package com.example.helloworld.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.builders.PathSelectors;


@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket createRestApi(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //com包下所有api
                .apis(RequestHandlerSelectors.basePackage(("com")))
                .paths(PathSelectors.any()).build();

    }
    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("exercise api")
                .description("exercise")
                .version("1.0")
                .build();
    }
}

好了编不下去了，swagger在我的项目里一直报错，干脆删掉了，有大佬知道怎么回事吗