swagger 文档

怼烎@ 2023-02-18 03:24 2阅读 0赞

**1. 导入依赖包**

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

** 2.文档在方法前，使用ApiImplicitParams配置**

@ApiOperation("测试")
    @PostMapping("/add")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id", value = "ID", dataType = "Long"),
            @ApiImplicitParam(name = "name", value = "名称", required = true, dataType = "String")
    })
    public RootResponse<?> add(Long id, String name) throws Exception {
    }

** 3.文档在方法中，使用ApiParam配置**

@ApiOperation("分页查询")
    @GetMapping("queryPageList")
    public xx queryPageList(
    @ApiParam(name = "pageNumber", value = "分页号", required = true) 
    @RequestParam(required = false) Integer pageNumber,
    @ApiParam(name = "pageSize", value = "分页大小", required = true) 
    @RequestParam(required = false) Integer pageSize)

** 4.文档在对象中，使用ApiModel和ApiModelProperty配置**

@EqualsAndHashCode(callSuper = true)
    @Data
    @AllArgsConstructor
    @NoArgsConstructor
    @ApiModel("测试-返回对象")
    public class xxxResponse {
        @ApiModelProperty(value = "名称", position = 1, required = true)
        private String name;
    
        @ApiModelProperty(value = "电话号码", position = 2, required = true)
        private String mobileNumber;
    }

发表评论取消回复

表情：

评论列表（有 0 条评论，2人围观）

还没有评论，来说两句吧...

相关阅读

相关 SpringBoot集成Swagger文档

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务(它的主要作用是：使得前后端分离开发更加方便，有利于团队协作接口...

短命女/ 2024年04月17日 06:46/ 0 赞/ 113 阅读

相关 Swagger文档转Word 文档

一、前言为什么会产生这个需求呢？我们公司作为乙方，老是被客户追着要一份API文档，当我们把一个 Swagger 文档地址丢给客户的时候。客户还是很不满意，嫌不够正式

骑猪看日落/ 2023年03月02日 13:23/ 0 赞/ 4 阅读

相关 swagger 文档

1. 导入依赖包 <dependency> <groupId>io.springfox</groupId> <artifactId>s

怼烎@/ 2023年02月18日 03:24/ 0 赞/ 3 阅读

相关 swagger生成pdf文档

<dependencies> <dependency> <groupId>io.github.swagger2markup</g

分手后的思念是犯贱/ 2022年10月17日 05:26/ 0 赞/ 336 阅读

相关 swagger 生成html文档

安装工具 npm install -g redoc-cli 生成文档 redoc-cli bundle -o index.html swagger

刺骨的言语ヽ痛彻心扉/ 2022年10月05日 06:51/ 0 赞/ 349 阅读

相关 Swagger文档转Word 文档

GitHub 地址：[https://github.com/JMCuixy/swagger2word][https_github.com_JMCuixy_swagger2wor

太过爱你忘了你带给我的痛/ 2022年09月04日 06:55/ 0 赞/ 392 阅读

相关 Swagger使用文档

Swagger([http://swagger.io/docs/][http_swagger.io_docs])主要提供了三个功能: > Swagger Editor:

客官°小女子只卖身不卖艺/ 2022年07月12日 05:41/ 0 赞/ 314 阅读

相关 Swagger文档 --

作用：Swagger是一个规范和完整的框架，用于生成，描述，调用和可视化RestFul风格的Web服务，主要用于接口文档的在线自动生成，功能测试。 Maven： <

冷不防/ 2022年05月16日 15:24/ 0 赞/ 239 阅读

相关 [Swagger]swagger构建你的api文档

Swagger能成为最受欢迎的REST APIs文档生成工具之一，有以下几个原因： Swagger 可以生成一个具有互动性的API控制台，开发者可以用来快速学习和尝试API。

ゞ浴缸里的玫瑰/ 2022年04月12日 07:40/ 0 赞/ 443 阅读

相关 springboot+swagger导出文档

1maven配置  <dependency> <groupId>io.spr

深碍√TFBOYSˉ_/ 2021年10月18日 22:34/ 0 赞/ 814 阅读