使用SpringBoot整合Swagger2构建API

本文介绍了如何在SpringBoot 2.1.0项目中整合Swagger2 2.9.2版本,创建API文档。内容包括:创建SpringBoot项目并添加Swagger2依赖,配置Swagger2Config文件,以及Swagger2的使用方法。
摘要由CSDN通过智能技术生成

关于如何创建SpringBoot项目本文不在说明,自行百度即可
本人使用的springboot 2.1.0版本,Swagger 2.9.2版本
本文创作时间:2018-12–07

1 创建SpringBoot项目,添加Swagger2的jar包

pom.xml配置如下
<properties>
    <swagger.version>2.9.2</swagger.version>
</properties>

<dependencies>
    <!--Swagger工具-->
    <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
    <dependency><!--添加Swagger依赖 -->
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>${swagger.version}</version>
    </dependency>
    <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
    <dependency><!--添加Swagger-UI依赖 -->
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>${swagger.version}</version>
    </dependency>
</dependencies>

2 新建Swagger2Config配置文件,代码如下

其中特别特别要注意的是里面配置了apis文件也就是controller包的路径,不然生成的文档扫描不到接口。
@Configuration
//用于开启Swagger
@EnableSwagger2
  • 1
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值