在spring boot swagger中手动指定POST请求正文
在Spring Boot Swagger中手动指定POST请求正文，可以通过使用@ApiImplicitParams和@ApiImplicitParam注解来实现。
首先，@ApiImplicitParams注解用于包含多个@ApiImplicitParam注解，用于描述请求参数的详细信息。每个@ApiImplicitParam注解用于描述一个请求参数。
下面是一个示例代码：
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class MyController {
@ApiImplicitParams({
@ApiImplicitParam(name = "body", value = "请求正文", required = true, dataType = "String", paramType = "body")
})
@PostMapping("/api/myendpoint")
public void myEndpoint(@RequestBody String body) {
// 处理请求正文
}
}在上面的代码中，@ApiImplicitParams注解包含了一个@ApiImplicitParam注解，用于描述请求正文参数。其中，name属性指定参数名称为"body"，value属性指定参数的描述为"请求正文"，required属性指定参数是否为必需的，dataType属性指定参数的数据类型为"String"，paramType属性指定参数的类型为"body"。
这样，通过Swagger生成的API文档中，就会显示出该POST请求需要指定请求正文。
推荐的腾讯云相关产品：腾讯云API网关（https://cloud.tencent.com/product/apigateway）可以帮助您构建和管理API，提供灵活、可靠的API服务。
相关·内容
2回答
如何在Spring boot for swagger UI中指定请求正文？
java、spring-boot、swagger
我有以下带注释的swagger控制器：
@PostMapping("/getMediaDataProduct/V2")
@ResponseBody
@ApiOperation(value = "get media data product v2")
@ApiResponses({@ApiResponse(code = 200, message = "Successful", response = MediaDataProductResponseV2.class)})
@ApiImplicitParams(va
浏览 1提问于2020-08-22得票数 1
3回答
为Swagger中的请求参数提供样本值
java、rest、spring-boot、swagger
我在Spring-Boot RestController中有一个rest方法的方法签名，如下所示：
@RequestMapping(
value = "/path",
method = RequestMethod.POST,
consumes = MediaType.APPLICATION_JSON_VALUE,
produces = MediaType.APPLICATION_JSON_VALUE
)
@ApiImplicitParams({
@ApiImplicitParam(
浏览 0提问于2016-09-02得票数 10
回答已采纳
3回答
带有Play框架的ImplicitParam中的Swagger数据类型模型
scala、playframework、swagger、swagger-ui、swagger-play2
我正在尝试使用Swagger来记录我的REST API。按照这个，我像这样注释REST端点：
case class CreateItemRequest(title: String, body: String)
@ApiOperation(value = "Create a new item", httpMethod = "POST", response = classOf[Item])
@ApiImplicitParams(Array(new ApiImplicitParam(dataType = "CreateItemRequest", pa
浏览 4提问于2015-03-03得票数 5
2回答
没有生成文档的Swagger数据类型
java、swagger、microservices、spark-java
我在Swagger有下面的代码，
@Path("/v1")
@ApiOperation(value = "POST - Some Value", nickname = "post-funtion", consumes = "application/json", produces = "text/html; charset=UTF-8", tags = {
"Some Controller" })
@ApiImplicitParams({
浏览 3提问于2017-06-27得票数 1
回答已采纳
1回答
傲慢的用户界面和播放路由*路径
java、routing、playframework-2.0、swagger、swagger-ui
我在Swagger理解Play！2.0路由通配符路由方面遇到了麻烦，所以swagger ui最终导致URL中断。我的路由文件有以下路由：
GET /settings/api/:project/*path @controllers.API.getParams(project, path)
然后，我的控制器有以下代码：
@ApiOperation(value = "Returns settings for given project and path.", response = String.class, httpMe
浏览 2提问于2015-08-24得票数 1
回答已采纳
1回答
使用Swagger注释记录数组类型的请求体
java、json、scala、swagger
我有一个资源可以接受具有数组类型的JSON主体的POST请求，例如：
[
{ "foo": "bar" },
{ "foo": "baz" },
...
]
要使用Swagger注释记录非集合类型，我可以这样做：
@ApiImplicitParams(Array(
new ApiImplicitParam(paramType = "body", dataType = "my.Request", required = true)
))
如何对数组体类型进行同样的操作，例如Seq[my.
浏览 2提问于2017-01-05得票数 3
回答已采纳
1回答
Springfox在Swagger2.0JSON定义中创建'ref‘类型而不是java.io.File对象
java、rest、swagger、java-io、springfox
我试图描述一个REST端点，它使用Swagger中的java.io.File注释将两个multipart/form-data对象作为multipart/form-data有效负载的一部分。在基础研究中，我发现这可以通过使用以下属性集(即type、dataType和paramType)指定隐式参数来实现。
@ApiImplicitParams({
@ApiImplicitParam(
name="controlFile",
value="Control file to be used
浏览 1提问于2020-05-05得票数 0
回答已采纳
2回答
在我的春季引导应用程序中大摇大摆
java、spring-boot、swagger、swagger-2.0
注释中的paramType是什么？
@ApiImplicitParams( {
@ApiImplicitParam( name = RestRequestHeader.XAUTHTOKEN, value = RestRequestHeader.VALUE, required = RestRequestHeader.REQUIRED, dataType = "string", paramType = "header" ) } )
paramType可以采取的不同值是什么?它的功能是什么？我试过在谷歌搜索，但没有找到任何令人满意的解决方案。
浏览 2提问于2017-04-11得票数 1
1回答
斯普林福克斯装腔作势Json错误
swagger-2.0、springfox
我刚开始自吹自擂。我有民俗密码：
@RestController
@RequestMapping(value = { V1P})
@Api(value = V1P, description= "My Operations Management API")
public class MethodController {
/**
* @return -
*/
@ApiOperation(value = "retrieve task information", notes = "retrieve service inst
浏览 2提问于2016-09-07得票数 0
1回答
Swagger-play2:如何使用@ApiImpl时play2注释在swagger中允许对象数组作为输入？
scala、functional-programming、swagger-ui、playframework-2.6、swagger-play2
我试图为一个接受case类对象数组的方法编写swagger。我所做的事情如下：
package models
import io.swagger.annotations.{ApiModel, ApiModelProperty}
import play.api.data.Form
import play.api.data.Forms.{mapping, nonEmptyText, seq}
import play.api.libs.json.{Json, Writes}
import spray.json.DefaultJsonProtocol
object Message extends
浏览 1提问于2019-12-09得票数 0
回答已采纳
1回答
Swagger-Akka-Http:请求体中的对象列表
scala、swagger、akka-http、swagger-akka-http
我正在使用为我的Akka HTTP服务构建Swagger文档。
我的服务有一个接受Characteristic的List的POST方法。
@ApiOperation(value = "Fetch offerings by characteristics", httpMethod = "POST")
@ApiImplicitParams(Array(
new ApiImplicitParam(name = "characteristics", required = true,
dataTypeClass = classOf[
浏览 0提问于2018-07-31得票数 0
1回答
如何在flutter的端点调用中正确输入参数？
spring-boot、flutter
我想在后端API中使用与spring boot完成的端点。端点包括通过电子邮件发送OTP代码。当我测试端点时，它可以正常工作，但我在flutter应用程序中调用了它，出现了这个错误：Required String is not present是端点代码的一部分：
@ApiImplicitParams({@ApiImplicitParam(name = "Authorization",
value = "Bearer bcryptjwttoken", paramType =
"header",r
浏览 0提问于2020-09-07得票数 0
1回答
Swagger不接受UI中的值
spring、spring-boot、swagger、swagger-ui、springfox
我只观察到补丁API swagger文档的奇怪行为。Path变量被标记为"ref“参数，不接受提交的值。 ? 请注意，这不会发生在GET、POST或PUT API文档中。你可以在下面看到区别。 ? 下面是swagger API配置： @ApiOperation(value = "update Jurisdictions", response = JurisdictionDto.class, authorizations = {@Authorization(value = "oauth2schema")})
@ApiResponses(v
浏览 12提问于2020-10-29得票数 0
1回答
资源url中的Swagger (喷雾)路径参数
scala、swagger、spray
假设我有一个参数化的资源url
/customers/{CUSTOMER-ID}/ownedItems/{ITEM-ID}
我应该如何注释/拆分我的喷雾路线(使用喷雾-傲慢插件)来生成一个文档来识别{CUSTOMER}作为一个正确的路径参数？
我的问题是顶层@Api注释接受的是路径，但没有参数，而@ annotation可以使用路径参数进行注释，但这些参数将被追加到后面。换句话说，如果我写：
@Api(value = "/customers/{CUSTOMER-ID}")
@ApiOperation(httpMethod = "GET")
@ApiImplic
浏览 0提问于2015-02-19得票数 5
回答已采纳
1回答
如何将来自HTTP请求体的数据传递到servlet
java、spring、spring-boot、jersey、jax-rs
我是Java编程新手，我读了下面使用Spring和swagger的代码。我无法理解jsonRequestBody参数是如何被来自HTTP请求主体的数据填充的。我从某个地方读到，应该使用@RequestBody注释来读取请求体，就像您如何使用@PathParam和@QueryParam一样，但在本例中不使用它。Spring是如何解析HTTP请求体并将其放入jsonRequestBody的
@POST
@Path("{transactionId}")
@Consumes({ MediaType.APPLICATION_JSON })
@Produce
浏览 1提问于2020-04-22得票数 0
回答已采纳
1回答
Swagger:将JAX-RS映射用于主体参数
java、rest、jax-rs、swagger
我正在尝试在我们现有的JAX-RS REST项目中设置Swagger来记录我们的API。
在我们接受JSON请求体的操作中，我们一直在使用这个习惯用法：
@POST
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
@ApiOperation(value="Some operation")
@ApiImplicitParams(value={
@ApiImplicitParam(name="val1", value="Input 1
浏览 1提问于2014-05-02得票数 1
1回答
Scala Play Swagger:嵌套@ApiImplicitParam定义
json、scala、playframework、annotations、swagger
我在我的项目中使用play-swagger + swagger-ui，但是我对json body的请求如下：
{"country":{"title": "Germany"}}'
当我用以下代码注释我的方法时：
ApiImplicitParam(name = "country[title]", value = "Country's title", required = true, dataType = "String", paramType = "body")
它在sw
浏览 4提问于2016-07-22得票数 0
1回答
@ApiResponses和@ApiResponses in swagger
spring-boot、swagger、swagger-ui、swagger-2.0
我注释了我的方法，如下所示：
@ApiOperation( value = "Get time spent on category", response = CategoryBean.class, responseContainer = "List", notes = "API to get the time spent on all tasks based on category" )
@ApiImplicitParams( {
@ApiImplicitParam( name = "x-auth-token",
浏览 0提问于2017-04-12得票数 2
1回答
从Spring后端与Google API通信的合适方式是什么？
java、spring、api、backend、google-translate
我正在尝试使用Spring从angular创建一个翻译器。所以在Spring中，我创建了这个端点
package com.vir.controller;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.http.MediaType;
import org.springframework.web.bind.annotation.PostMa
浏览 0提问于2018-02-09得票数 0
1回答
Swagger ApiImplicitParam有没有办法为参数和api定义单独的名称？
java、swagger、openapi
我现在从注解中生成swagger，并试图在短时间内清理生成，同时先转到模式，所以我有： @ApiImplicitParams({
@ApiImplicitParam(
name = "x-my-header-name", dataType = "string", paramType = "header", allowMultiple = true,
allowableValues = "A,B,C,D",
浏览 41提问于2020-07-15得票数 0
回答已采纳
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
实时音视频
即时通信 IM
对象存储活动推荐
腾讯云开发者
