Swagger2接口文档注解说明

最新推荐文章于 2023-07-21 17:24:00 发布
最新推荐文章于 2023-07-21 17:24:00 发布
阅读量191 收藏
点赞数
分类专栏： swagger 文章标签： 服务器 java
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_52973645/article/details/130502868
版权

在前后端项目中，通常都是口口相传，但也可以借助接口文档来提高前后端的效率

后端使用swagger文档注解（每个注解有多个参数，在此只表明常用的参数）
    controller相关注解
    @Api 用在请求的类上，表示对类的说明
    ——tags 描述请求类的作用，非空时会覆盖value
    ——value 描述类的作用

    接口相关注解
    @ApiOperation 用在请求类的方法上，说明方法的用途和作用
    ——value 方法的简要说明
    ——notes 方法的备注说明
    
    请求参数相关注解
    @ApiParam 用在请求体的参数上，描述请求体信息
    - name 参数名称
    - value 参数的简要说明
    - required 当前参数是否为必传
    - defaultValue 为参数设置默认值
    
    @ApilmplicitParams 用在请求方法上，表示一组参数说明，里面是 @ApiImplicitParam 列表
    @ApilmplicitParam 用在@ApiImplicitParams 注解中，一个请求参数的说明
    - name 参数名称，参数名称覆盖方法参数名称
    - value 参数的说明，解释
    - required 参数是否必传 默认为false
    - defaultValue 参数的默认值

    接口响应注解    
    @ApiResponses 用在请求的方法上，表示一组响应
    @ApiResponse  用在@ApiResponse 中，一般用于表达一个错误的响应信息
    - code 响应状态码
    - message 响应信息
    - response 抛出异常的类

    实体类相关注解
    @ApiModel 用在实体类（模型）上，表示相关实体的描述
    - value 模型的备注名
    - description 该类的详细说明
    @ApiModelProperty 用在实体类的属性上，表示属性的相关描述
    - value 属性的简要描述

开始学前端的后端工作者
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
专栏目录
Swagger2常用注解（详细教程）
as1517的博客
04-19 408
Swagger2常用注解（详细教程）
SpringBoot集成Swagger2生成接口文档的方法示例
08-26
SpringBoot集成Swagger2生成接口文档的方法是开发RESTful API时常用的一种高效手段，它能够自动生成详细的API文档，便于开发者理解和使用。Swagger2是一个强大的工具，它可以与SpringBoot框架无缝结合，提供实时更新...
swagger 接口文档注释
08-21
微服务分布式架构实践，swagger 接口文档注释，下载即运行【代码完整】
Abp 为Swagger接口页添加详细注释
你要明白，任何问题都不是孤立存在的，一定有人曾经遇到过，并且已经有更好的解决办法了，只是我还不知道。我不应该在黑暗中独自前行，去重新发明轮子，也许我的顿悟，只是别人的基本功！我应该要站在巨人的肩膀上，学习更成熟的经验和方法，然后再来解决这个问题
08-12 2024
从Abp官网创建完项目之后，启动之后，Swagger的接口说明页，默认是没有接口说明的，这样是很不友好的，也不利于接口调用者的使用，所以，我们要实现Swagger页面的接口注释功能。 首先，我们看一下默认启动后，Swagger的接口页面，标红的是我们自己写的获取所有组织机构的接口，默认是没有注释的。 接下来，我们选中我们Application层的项目，右键“属性”，将输出路径选择为“bin\Debug\”，然后再勾选为Xml生成文档，如下图所示。 接下来，在你的 项目名...
swagger2注解作用于类，方法，参数，实体类上
zouyang920的博客
08-03 676
@ApiModel(value="user对象",description="用户对象user") public class User implements Serializable{ private static final long serialVersionUID = 1L; @ApiModelProperty(value="用户名",name="username",example="xingguo") private String username; @ApiM.
关于Swagger生成接口文档的一些注解
最新发布
kengou_的博客
07-21 202
注解：用于在实体类的属性上添加，用来对属性进行说明和描述。它的作用是在 Swagger 文档中显示属性的详细信息，包括名称、描述、示例值等。注解：用于在实体类上添加，用于表示这是一个实体类。它可以帮助在 Swagger 文档中正确显示这个类。注解：用于在 Controller 类上添加，用来描述 Controller 的作用。注解：用于在 Controller 类的方法上添加，用来描述方法的作用。属性通常用于提供 Controller 的简要描述或名称。属性通常用于提供方法的简要描述或名称。
django-rest-swagger显示接口备注内容
Allen . Liu
08-25 889
Swagger是一個API開發者的工具框架，用於生成、描述、調用和可視化RESTful風格的Web服務。總體目標是使客戶端和文件系統服務器以同樣的速度來更新，方法，參數和模型緊密集成到服務器端的代碼中，允許API始終保持同步。 在使用 django-rest-framework 進行API開發，可以使用django-rest-swagger接入swagger自動生成接口文檔。 1. 安裝django-rest-swagger pip install django-rest-swagger 2.配置
Spring boot集成swagger2生成接口文档的全过程
08-25
在本文中，我们将深入探讨如何将Swagger2与Spring Boot整合以生成接口文档。Swagger是一个强大的工具，它允许开发者自动生成RESTful API的文档，并提供一个交互式的界面进行接口测试。让我们一步步了解如何在Spring ...
使用node生成swagger接口文档
01-08
在项目中运行`cnpm install express-swagger-generator`，这会添加`express-swagger-generator`模块，它可以帮助我们自动生成Swagger接口文档。`express`是Node.js中的一个流行web框架，我们将在这个框架上构建我们...
Java利用Swagger2自动生成对外接口的文档
08-27
Swagger目前有两种，Swagger和Swagger2，本文主要记录了使用Swagger2对外接口文档的两种方式。 Swagger2是Swagger的升级版本，提供了更好的性能和功能，包括自动生成API文档、在线测试API接口等。Swagger2可以与...
基于swagger2的api注释
weixin_51451545的博客
06-14 548
本文介绍了Swagger2框架中常用的几个注释标签，包括@ApiParam、@ApiImplicitParams、@ApiImplicitParam、@ApiModel和@ApiModelProperty等。通过这些注释标签，开发人员可以更好地对API接口、参数和实体类进行描述，让API更加规范、可读性更高、易于使用和测试。其中，@ApiParam和@ApiImplicitParam注释用于描述API接口参数信息，包括参数名称、描述、是否必填、参数类型等；@ApiModel和@ApiModelPropert
可变参数
weixin_52284319的博客
12-03 131
可变参数 在JDL1.5之后，如果我们定义一个方法，需要接收多个参数，并且多个参数的数据类型一致，那么我们可以简化成如下格式： 修饰符 返回值类型 方法名(参数类型... 形参名){ //... } 其实上面的格式，完全等价于下面的格式 修饰符 返回值类型 方法名(参数类型[] 参数名){ //... } ​ 只是后面的写法，在方法调用时，必须传递一个数组类型，而前者可以直接传递参数数据。 JDK1.5之后出现的简化操作。"…"用在参数上，我们称之为可变参数。 ​ 同样是代表数组，但是在
swagger2 介绍+注解说明
.
01-10 7501
swagger接口文档API优势: 1.支持 API 自动生成同步的在线文档：使用 Swagger 后可以直接通过代码生成文档，不再需要自己手动编写接口文档了，对程序员来说非常方便。 2.提供 Web 页面在线测试 API：有文档还不够，Swagger 生成的文档还支持在线测试。参数和格式都定好了，直接在界面上输入参数对应的值即可在线测试接口。
swagger的注解使用
qq_39871957的博客
01-04 408
这里写自定义目录标题swagger的注解使用类上的注解方法的注解参数注解展示对象里面的字段注解5.实体类的注释 swagger的注解使用 类上的注解 @Api(tags = “签到模块”) 在类上使用 效果如下： 方法的注解 @ApiOperation(value = “签到接口”, notes = “”) 方法上使用 参数注解 @RequestParam(required = true) @...
【整理】swagger2注解说明
全栈测试笔记
01-24 150
@Api @Api：用在请求的类上，表示对类的说明 tags="说明该类的作用，可以在UI界面上看到的注解" value="该参数没什么意义，在UI界面上也看到，所以不需要配置" @ApiOperation @ApiOperation：用在请求的方法上，说明方法的用途、作用 value="说明方法的用途、作用" notes="方法的备注说明" @Api...
Swagger:Swagger中的常用注解
weixin_47609997的博客
07-27 8112
一、@Api 多作用在Controller类上，用来描述类信息 参数： 1.description：描述这个类的作用。 2.tags：设置这个类的一个标签。 @Api(tags = "招聘管理",description = "用于招聘模块的测试") @Controller public class ResumeController { } 二、@ApiOperation 作用在Controller类的方法上，用来描述接口信息 参数：value可以加以说明 @ApiOperatio
swagger api的@Api以及@ApiImplicitParam注解详解
季白之二七的博客
08-27 1531
原文地址：https://www.cnblogs.com/caiwx/p/11132163.html @Api：用在请求的类上，表示对类的说明 tags=“说明该类的作用，可以在UI界面上看到的注解” value=“该参数没什么意义，在UI界面上也看到，所以不需要配置” @ApiOperation：用在请求的方法上，说明方法的用途、作用 value=“说明方法的用途、作用” notes=“方法的备注说明” @ApiImplicitParams：用在请求的方法上，表示一组参数说明 @ApiImplicitPa
SpringBoot小知识点(一)
有点想法的专栏
07-18 572
文章目录1.为啥要用SpringBoot2.什么是Spring Boot Starter？3.lombok注解简化开发4.热部署热加载设置5.Restful6.Json6.1 常用注解6.2 手动对象转换789参考 1.为啥要用SpringBoot 在spring boot出现以前，使用spring框架的程序员是这样配置web应用环境的，需要大量的xml配置。 随着web项目集成软件的不断增多，xml配置也不断的增多，xml配置文件也在不断地增多，项目的依赖管理也越发的复杂。spring框架也因此饱受争议
Swagger使用纪要
Derek7117的博客
03-15 1021
Swagger常用注解说明
swagger2生成api接口文档
05-24
Swagger 是一个用于构建、文档化和使用 RESTful Web 服务的开源工具。Swagger 有很多版本，其中 Swagger2 是其中最常用的一个版本。Swagger2 可以通过注解的方式生成 API 接口文档，这些注解包括 @Api、@ApiOperation、@ApiParam 等。 下面是使用 Swagger2 生成 API 接口文档的步骤： 1. 添加 Swagger2 依赖 在项目的 pom.xml 文件中添加 Swagger2 的依赖： ``` <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.9.2</version> </dependency> ``` 2. 配置 Swagger2 在 Spring Boot 应用的启动类上添加 @EnableSwagger2 注解开启 Swagger2 支持，并配置 Docket 对象： ``` @Configuration @EnableSwagger2 public class SwaggerConfig { @Bean public Docket api() { return new Docket(DocumentationType.SWAGGER_2) .select() .apis(RequestHandlerSelectors.any()) .paths(PathSelectors.any()) .build(); } } ``` 这个配置会扫描所有的 Controller 类，并生成 API 接口文档。 3. 添加 Swagger2 注解 在 Controller 类的方法上添加 Swagger2 注解，包括： - @Api：用于标识这个 Controller 类的作用和说明。 - @ApiOperation：用于标识这个方法的作用和说明。 - @ApiParam：用于标识方法参数的作用和说明。 示例代码： ``` @RestController @RequestMapping("/api") @Api(value = "HelloWorldController", description = "示例控制器") public class HelloWorldController { @GetMapping("/hello") @ApiOperation(value = "打招呼", notes = "向用户打招呼") public String hello(@ApiParam(name = "name", value = "用户名", required = true) @RequestParam String name) { return "Hello, " + name + "!"; } } ``` 4. 访问 Swagger UI 启动应用后，访问 http://localhost:8080/swagger-ui.html 可以看到 Swagger UI 界面，其中包含了生成的 API 接口文档。在这个界面中，可以查看 API 接口的详细信息、测试 API 接口等。 以上就是使用 Swagger2 生成 API 接口文档的步骤。

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值