SpringBoot集成Swagger的方法

我的新书《Android App开发入门与实战》已于2020年8月由人民邮电出版社出版,欢迎购买。点击进入详情

1.系列文章

IDEA+SpringBoot+MyBatis Dynamic SQL搭建后台系统

在上面这文章基础上,我们增加Swagger功能。
Swagger可以直接生成接口文档,并且增加注释,开发人员可以直接在网页上调试API接口。

2.pom

集成swagger,需要添加它的依赖:

		<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>3.0.0</version>
        </dependency>

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>3.0.0</version>
        </dependency>

3.代码配置

  1. 首先需要在application里面添加相应的annotation:
@EnableWebMvc
@EnableSwagger2
@SpringBootApplication
public class Application {
  1. 添加SwaggerConfig文件:
@Configuration
@EnableSwagger2
public class SwaggerConfig {
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2);
    }

    @Bean
    public InternalResourceViewResolver defaultViewResolver() {
        return new InternalResourceViewResolver();
    }
}
  1. swagger的API配置信息
    比如ApiOperation这个annotation,value表示这个api的作用,notes表示这个api的详细信息。
@GetMapping("/")
    @ApiOperation(value = "获取所有用户")
    public List<User> getUsers() {
        return userService.selectAll();
    }

4.运行

run后,打开:http://localhost:8080/swagger-ui/
在这里插入图片描述

5.代码地址

https://github.com/ddnosh/weekly-sample-backend

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值