千家信息网

Springboot项目接口之swagger怎么用

发表于:2025-01-25 作者:千家信息网编辑
千家信息网最后更新 2025年01月25日,这篇文章给大家介绍Springboot项目接口之swagger怎么用,内容非常详细,感兴趣的小伙伴们可以参考借鉴,希望对大家能有所帮助。step1:pom文件引入swagger插件 io.springfox springfox-swagger2 2.9.2 io.springfox springfox-swagger-ui 2.9.2 org.springframework.boot spring-boot-starter-web

step2:添加SwaggerConfig.java

package com.ggkt.crm.admin.config;import org.springframework.beans.factory.annotation.Value;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;/** * Title: Swagger * Description:接口测试(可用、可不用) * @author ggkt * */@Configuration@EnableSwagger2public class SwaggerConfig {        @Value(value = "${swagger.enabled}")        private Boolean swaggerEnabled;                 @Bean    public Docket createAllotManageApi() {        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())                .groupName("分配管理")                // 是否开启                .enable(swaggerEnabled).select()                // 扫描的路径包                .apis(RequestHandlerSelectors.basePackage("com.ggkt.crm.admin.allotManage.dataType.controller"))                // 指定路径处理PathSelectors.any()代表所有的路径                .paths(PathSelectors.any()).build().pathMapping("/");    }                @Bean    public Docket createMarketManageApi() {        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())                .groupName("营销管理")                // 是否开启                .enable(swaggerEnabled).select()                // 扫描的路径包                .apis(RequestHandlerSelectors.basePackage("com.ggkt.crm.admin.marketManage"))                // 指定路径处理PathSelectors.any()代表所有的路径                .paths(PathSelectors.any()).build().pathMapping("/");    }    @Bean    public Docket createBaseManageApi() {        return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())                .groupName("基础配置管理")                // 是否开启                .enable(swaggerEnabled).select()                // 扫描的路径包                .apis(RequestHandlerSelectors.basePackage("com.ggkt.crm.admin.baseManage"))                // 指定路径处理PathSelectors.any()代表所有的路径                .paths(PathSelectors.any()).build().pathMapping("/");    }    private ApiInfo apiInfo() {        return new ApiInfoBuilder()                .title("接口文档")                .description("API")                .version("1.0.0")                .build();    }}

step3:domain类注释方式

step4:Controller类的注释方式

step5:application.yml配置


6、接口访问
http://localhost:9099/admin/swagger-ui.html

关于Springboot项目接口之swagger怎么用就分享到这里了,希望以上内容可以对大家有一定的帮助,可以学到更多知识。如果觉得文章不错,可以把它分享出去让更多的人看到。

0