swagger2简单的配置步骤

本文详细介绍如何在SpringBoot项目中集成Swagger2,包括Maven依赖配置、Swagger配置文件设置及启动验证步骤。通过示例代码展示如何指定Controller包路径,自定义API文档信息。

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

看有些springboot的项目还没有配置swaggger2接口文档的时候觉得不错所以项目简单引用下
1.pom文件引用

父类pom

  			 <!--- swagger2  -->
  			 maven中的dependencyManagement标签内
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger2</artifactId>
                <version>2.9.2</version>
            </dependency>
            <dependency>
                <groupId>io.springfox</groupId>
                <artifactId>springfox-swagger-ui</artifactId>
                <version>2.9.2</version>
            </dependency>

子类项目中pom引用
		 <!-- swagger2-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
        </dependency>


上面这样配置maven配置的一个通用路子

  1. swagger2配置文件配置
    RequestHandlerSelectors.basePackage(“com.github.security.auth.controller”) 这个提出来说下,需要注意的是放自己的controller的包位置
/**
 * @ClassName SwaggerConfig
 * @Description TODO
 * @Author tanli
 * @Date 2020-06-09
 * @Since 1.0
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

        @Bean
        public Docket createRestApi() {
            return new Docket(DocumentationType.SWAGGER_2)
                    .pathMapping("/")
                    .select()
                    .apis(RequestHandlerSelectors.basePackage("com.github.security.auth.controller"))
                    .paths(PathSelectors.any())
                    .build().apiInfo(new ApiInfoBuilder()
                            .title("SpringBoot整合Swagger")
                            .description("SpringBoot整合Swagger,详细信息......")
                            .version("9.0")
                            .contact(new Contact("测试","blog.youkuaiyun.com","tanli_0908@g163.com"))
                            .license("The Apache License")
                            .licenseUrl("http://www.csdn.com")
                            .build());
        }

}

如上配置完之后重启项目

输入地址:http://IP:端口/swagger-ui.html
得到页面如图:
在这里插入图片描述
简单的引用就已经可以用了,
设置多个个选择框可以看我另一篇文档
https://blog.youkuaiyun.com/iteye_9328/article/details/103120925

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值