SwaggerConfig配置

时间:2025-03-18 14:20:59

1.引入swagger的jar包

<!--swagger 的jar-->
        <dependency>
            <groupId></groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId></groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

注:此处直接复制可能出现最后一个</dependency>标签前面有空格报错,把空格删了就ok了

2.配置文件内容如下

创建一个config包,建议创建在basic包下,配置文件.class建议命名为SwaggerConfig

@Configuration
@EnableSwagger2
public class SwaggerConfig {

        /*
            这个方法的返回值交给Spring 管理
         */
        @Bean
        public Docket petApi() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(apiInfo())
                    .select()
                    //哪些包需要生成文档
                    .apis(("基包名")) //指定提供接口所在的基包
                    .build();
        }
        /**
         * 该套 API 说明,包含作者、简介、版本、host、服务URL
         * @return
         */
        private ApiInfo apiInfo() {
            return new ApiInfoBuilder()
                    .title("文章title")
                    .contact(new Contact("hmtest", "", "hm@域名反写"))
                    .version("版本")
                    .description("API")
                    .build();
        }

    }

注:.contact会报错,需要手动导包,有两个包可选,选择包即可

3.直接使用localhost/访问即可

注:需重启服务器