swagger注释API详细说明
API详细说明
注释汇总
作用范围 API 使用位置 |
对象属性 @ApiModelProperty 用在出入参数对象的字段上 |
协议集描述 @Api 用于controller类上 |
协议描述 @ApiOperation 用在controller的方法上 |
Response集 @ApiResponses 用在controller的方法上 |
Response @ApiResponse 用在 @ApiResponses里边 |
非对象参数集 @ApiImplicitParams 用在controller的方法上 |
非对象参数描述 @ApiImplicitParam 用在@ApiImplicitParams的方法里边 |
描述返回对象的意义 @ApiModel 用在返回对象类上 |
@RequestMapping此注解的推荐配置
value
method
produces
示例:
@ApiOperation("信息软删除")
@ApiResponses({ @ApiResponse(code = CommonStatus.OK, message = "操作成功"),
@ApiResponse(code = CommonStatus.EXCEPTION, message = "服务器内部异常"),
@ApiResponse(code = CommonStatus.FORBIDDEN, message = "权限不足") })
@ApiImplicitParams({ @ApiImplicitParam(paramType = "query", dataType = "Long", name = "id", value = "信息id", required = true) })
@RequestMapping(value = "/remove.json", method = RequestMethod.GET, produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
public RestfulProtocol remove(Long id) {
@ApiModelProperty(value = "标题")
private String title;
@ApiImplicitParam
属性 取值 作用 |
paramType 查询参数类型 |
path 以地址的形式提交数据 |
query 直接跟参数完成自动映射赋值 |
body 以流的形式提交 仅支持POST |
header 参数在request headers 里边提交 |
form 以form表单的形式提交 仅支持POST |
dataType 参数的数据类型 只作为标志说明,并没有实际验证 |
Long |
String |
name 接收参数名 |
value 接收参数的意义描述 |
required 参数是否必填 |
true 必填 |
false 非必填 |
defaultValue 默认值 |
paramType 示例详解 |
path
@RequestMapping(value = "/findById1/{id}", method = RequestMethod.GET, produces = MediaType.APPLICATION_JSON_UTF8_VALUE)
@PathVariable(name = "id") Long id
body
@ApiImplicitParams({ @ApiImplicitParam(paramType = "body", dataType = "MessageParam", name = "param", value = "信息参数", required = true) })
@RequestMapping(value = "/findById3", method = RequestMethod.POST, produces = MediaType.APPLICATION_JSON_UTF8_VALUE, consumes = MediaType.APPLICATION_JSON_VALUE)
@RequestBody MessageParam param
提交的参数是这个对象的一个json,然后会自动解析到对应的字段上去,也可以通过流的形式接收当前的请求数据,但是这个和上面的接收方式仅能使用一个(用@RequestBody之后流就会关闭了)
header
@ApiImplicitParams({ @ApiImplicitParam(paramType = "header", dataType = "Long", name = "id", value = "信息id", required = true) })
String idstr = request.getHeader("id");
if (StringUtils.isNumeric(idstr)) {
id = Long.parseLong(idstr);
}
Form
@ApiImplicitParams({ @ApiImplicitParam(paramType = "form", dataType = "Long", name = "id", value = "信息id", required = true) })
@RequestMapping(value = "/findById5", method = RequestMethod.POST
https://blog.csdn.net/xupeng874395012/article/details/68946676
分享到:
相关推荐
Swagger是一个强大的API开发工具,主要用于设计、构建、文档化和使用RESTful web服务。在这个名为"swagger2Demo"的项目中,我们看到作者利用Swagger 2创建了一个演示应用,目的是为了展示如何使用Swagger来调试接口...
### swagger开启身份认证 在现代Web开发中,API文档自动生成工具如Swagger变得越来越重要,它们不仅能够提高开发效率,还能够帮助团队更好地管理和维护API接口。然而,随着API暴露给外部用户,安全问题也日益突出。...
Swagger官方文档离线版是开发人员和团队在不依赖互联网连接的情况下查阅Swagger 2.0规范的重要资源。Swagger是一个流行的API开发工具,它基于OpenAPI Specification(以前称为Swagger specification),用于设计、...
Swagger 是一个流行的API开发工具,它提供了一套规范和实现,用于设计、构建、文档化和使用RESTful Web服务。在Java环境中,Swagger通常与Spring Boot框架结合使用,以简化API的开发和测试过程。本篇文章将深入探讨...
springboot 2.2.7集成swagger2.9.2,并生成markdown格式API文档. <!-- swagger2 依赖开始--> <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --> <groupId>io.springfox ...
Swagger是一个流行的API开发工具,主要用于构建、文档化和测试RESTful web服务。它提供了一种交互式的、基于HTTP的API接口,使得开发者可以轻松地理解并使用这些接口。Swagger通过JSON格式来描述API,使得服务的消费...
Swagger 是一个广泛使用的 API 设计和开发工具,它允许开发者以 YAML 或 JSON 格式定义 RESTful 风格的 Web 服务接口。这个压缩包文件 "swagger" 可能包含了 Swagger 的静态资源,这些资源主要用于展示和测试 API ...
现在市面上的swagger UI不足之处 1、原生UI显示的有些不够漂亮和清晰,特别是request 的model部分 2、每个服务都需要引入一套资源文件,不能作为一个中间件为其他API使用 3、默认通用配置繁琐,每个项目都需要复制...
Swagger UI 是一个强大的工具,用于交互式地展示和测试API接口。它基于Swagger规范,能够帮助开发者轻松地理解和使用API。在Spring框架中整合Swagger UI,可以为开发、测试和文档化RESTful服务提供极大的便利。这篇...
Swagger2是一个广泛使用的API文档和测试工具,它允许开发者通过注解轻松地在Java应用程序中定义RESTful API接口。这个“swagger2依赖包”包含了Swagger2实现所需的关键组件,使得开发人员可以自动化生成API的客户端...
通过添加`springfox-swagger2`和`springfox-swagger-ui`依赖,我们可以在项目中启用Swagger UI,它是一个Web界面,能够展示API的详细信息。 ```xml <groupId>io.springfox <artifactId>springfox-swagger2 ...
### TP5集成Swagger知识点详解 #### 一、Swagger概述与工作原理 Swagger是一个规范和完整的框架,用于生成、描述、调用和可视化RESTful风格的Web服务。它旨在解决的一个核心问题是API文档的生成和维护问题。对于...
Swagger 自定义UI界面 Swagger 是一个流行的 API 文档生成工具,能够自动生成 RESTful API 的文档,帮助开发者快速了解 API 的使用方法和参数信息。在本文中,我们将讨论如何使用 Swagger 在 Spring Boot 2.0 项目...
Swagger是一个流行的API文档工具,它允许开发者以结构化的方式定义和文档化RESTful API。在.NET环境中,Swagger(也称为Swashbuckle)为ASP.NET Web API提供了强大的支持,包括生成交互式的API文档。本教程将围绕...
Swagger是一个强大的API文档工具,它允许开发者通过注解在代码中定义RESTful API,并自动生成交互式的文档,便于测试和调试。在Spring MVC框架中,Swagger可以与之完美结合,帮助开发人员更轻松地管理API接口。这个...
Swagger是一个流行的API开发工具,主要用于设计、构建、文档化和使用RESTful web服务。在.NET框架中,Swagger可以通过Swashbuckle库实现,这个库为ASP.NET Web API提供了集成Swagger的功能。在这个.NET 4.5版本的...
Swagger 是一个广泛使用的 API 设计和文档工具,它允许开发者以 YAML 或 JSON 格式定义 RESTful API,并通过 Swagger UI 进行交互式测试和展示。在标题“swagger实现多项目api管理”中,提到的核心知识点是利用 ...
Swagger 是一个用于生成、描述和调用 RESTful 接口的 Web 服务。通俗的来讲,Swagger 就是将项目中所有(想要暴露的)接口展现在页面上,并且可以进行接口调用和测试的服务。swagger可以将项目中所有的接口展现在...
SpringBoot整合Swagger项目是一个实用的例子,它展示了如何在SpringBoot应用程序中集成Swagger,以便于创建API文档和进行接口测试。Swagger是一个强大的工具,用于设计、构建、文档化和使用RESTful Web服务。在这个...
Swagger 是一个广泛使用的开源工具,主要用于构建、设计和文档化 RESTful API。它提供了一种交互式的、基于HTTP的API接口,使得开发者可以方便地测试、理解和使用API。在WebLogic服务器环境中,Swagger可以帮助我们...