前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >swagger接口文档生成工具

swagger接口文档生成工具

作者头像
java后端指南
发布2021-05-13 16:56:45
1.1K0
发布2021-05-13 16:56:45
举报
文章被收录于专栏:java后端java后端

今日主题:swagger接口文档生成工具

简介

在一个大的的项目中可能会有很多控制类,每个控制类中会有很多方法,这时候我们需要一个接口文档生成工具来暴露这些接口,方便我们进行直接查找测试,确实是方便了很多,那么来学习一下吧

环境

  • springboot
  • swagger2.x

实现过程

1、创建一个springboot项目工程,添加依赖

代码语言:javascript
复制
<!--swagger-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.4.0</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.4.0</version>
        </dependency>

2、添加配置文件

代码语言:javascript
复制
//swagger2的配置文件,在项目的启动类的同级文件建立
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()  // 选择那些路径和api会生成document
                .apis(RequestHandlerSelectors.any()) // 对所有api进行监控
                .paths(PathSelectors.any()) // 对所有路径进行监控
                .build();
    }

}

3、准备控制类

代码语言:javascript
复制
@PostMapping("/hello")
    @ApiOperation(value = "测试",notes = "这是一个测试文档")
    public String hello(){
        return "hello";
    }

4、启动项目,访问地址:http://localhost:端口/swagger-ui.html/

这里可以进行测试

Swagger全部是以JSON的格式向后台传参的

这是非常重要的一点,我自己找了很多文章才发现的,入参都是以json格式的,也就是说只支持@RequestBody的入参。

想下面这个就不行:

代码语言:javascript
复制
@GetMapping("/test")
    public String test(String test){
        return test;
    }

大家可以看到响应体是no content

其实这里也已经给我们答案了,参数类型只支持json格式

本文参与 腾讯云自媒体分享计划,分享自微信公众号。
原始发表:2021-01-30,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 java后端指南 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 今日主题:swagger接口文档生成工具
    • 简介
      • 环境
        • 实现过程
        领券
        问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档