Swagger不显示响应正文
Swagger是一种用于设计、构建、文档化和使用RESTful Web服务的开源工具集。它提供了一种简单且易于理解的方式来描述API的结构和功能，并生成交互式文档，以便开发人员和用户可以更好地理解和使用API。
在Swagger中，如果API的响应正文未显示，可能是由于以下几个原因：
- 缺少正确的响应模型定义：Swagger需要通过定义响应模型来了解API的响应结构。如果没有正确定义响应模型，Swagger将无法显示响应正文。解决方法是在API的响应中添加正确的模型定义。
- 响应正文格式不正确：Swagger支持多种响应正文格式，如JSON、XML等。如果API的响应正文格式不正确或不符合Swagger支持的格式要求，Swagger将无法正确显示响应正文。解决方法是确保API的响应正文格式正确，并符合Swagger的要求。
- Swagger配置错误：Swagger的配置文件可能存在错误，导致无法正确显示响应正文。解决方法是检查Swagger的配置文件，确保配置正确并与API的实际情况相匹配。
对于以上问题，腾讯云提供了一款名为API网关的产品，它可以与Swagger集成，帮助开发人员更好地管理和使用API。API网关提供了丰富的功能，包括API的访问控制、流量控制、安全认证等，可以帮助开发人员更好地管理和保护API。您可以通过腾讯云API网关产品的官方文档了解更多信息：API网关产品介绍。
相关·内容
我的Swagger端点总是在响应正文中显示"no content“。尽管如此，服务器还是会返回一个有意义的响应文本。 ? ? ?
浏览 310提问于2021-03-31得票数 0
回答已采纳
我使用了apispec和flask-swagger-ui和flask。 flask路由返回一个html页面，但在swagger UI上，我只能看到html代码，而不能看到实际的页面。 有没有办法让html页面显示在swagger UI上。 flask代码和APIspec文档 ? swagger UI响应 ? 预期响应 ?
浏览 47提问于2021-02-28得票数 0
回答已采纳
我使用swagger-ui-express模块为我的node js后端构建了一个swagger。我有一个返回文件( pdf-doc或xlsx)的端点。当我在swagger上测试我的端点时，它返回200响应，并在body上始终显示此消息‘无法识别响应类型；将内容显示为文本。’这是我的swagger端点的代码。
"/reports?typeDoc={typeDoc}&file={file}": {
"get": {
"tags": [
浏览 2提问于2019-06-06得票数 5
我在定义、生成的代码和许多东西之间有点迷茫，即使在调试之后也是如此。 但让我们从头开始。我有一个用node编写的应用程序接口，使用NestJS作为框架。NestJS自动创建swagger/openapi json文件。我使用swagger-codegen创建了一个PHP类，以便从另一个服务器访问API。对于简单的API请求来说，它就像一个护身符。 现在的问题是API请求返回了更大的响应，即来自一个或多个DB的>1000行。不要让客户机等待太长时间，并在服务器上创建一个大的JSON响应，我已经切换到NDJSON，它将响应分成较小的JSON部分，每个JSON部分在自己的行上。当我使用cur
浏览 41提问于2020-08-08得票数 0
我正在使用Django Rest框架构建一个简单的API。此接口不存储任何内容，但用作另一个API的代理，用于查询商店是否有牛奶。所以我做了一个简单的序列化程序和视图：
class HasMilkSerializer(serializers.Serializer):
store = serializers.CharField(min_length=6, max_length=6)
passage_at = serializers.DateTimeField()
class HasMilkView(CsrfExemptMixin, APIView):
http_meth
浏览 6提问于2021-09-13得票数 0
4回答
我正在用Swagger和NodeJS构建API，到目前为止我遇到的恼人的问题是Swagger验证了响应，而且并不总是很顺利。
我的案子：
在文件.yaml中:我使用Swagger检查了yaml语法，=>文件是正确的。
/user/createNew:
x-swagger-router-controller: xxxxxxx
post:
tags:
- User
summary: Create New User
# used as the method name of the controller
operationId: createNewUser
paramet
浏览 10提问于2017-02-11得票数 2
回答已采纳
在使用swagger编辑器时，我创建了下面的YAML，它显示了response对象的示例。它可以正确地显示在swagger编辑器中。然后，当我下载JSON并将其显示在swagger-ui中时，示例完全丢失了。
/person/{email}/create:
post:
summary: Create a new account
tags:
- Person
parameters:
...
responses:
201:
description: The new SQL ident and sport det
浏览 3提问于2017-01-28得票数 7
我使用openapi 3.0来编写swagger yaml文件。但是上传文件功能不起作用。swagger ui没有按预期显示upload按钮。下面是我的swagger yaml代码片段。有人能帮我看一下吗？谢谢！ /uploadfiles:
post:
requestBody:
content:
multipart/form-data:
schema:
required:
- file_list
- statement_termi
浏览 95提问于2021-07-15得票数 0
1回答
是否有可能在swagger集线器中展开和折叠响应。只有在单击一种类型的响应时，它才会展开。因为太多的响应占用了swagger hub文档中的大量空间。
浏览 0提问于2019-10-03得票数 0
所以，我使用API来获取数据，它会返回一个包含印地语字符的字符串。但是当我打印response.body时，它显示如下(胡言乱语)
现在我的模拟器屏幕上也显示了同样的内容，但如果我复制粘贴的印地语文本并渲染，它就可以工作了：
两个场景的代码片段，即来自API响应的标题数据和正文中相同的字符串复制粘贴(并按预期工作)：
ListTile(
dense: true,
contentPadding: EdgeInsets.all(0),
浏览 9提问于2020-05-17得票数 0
回答已采纳
我有一个Swagger框架(不是核心)，其中我使用Swashbuckle为我的.net自动生成Swagger文档。 我还添加了Swashbuckle examples。 我想使用SwaggerResponseExample来显示示例返回数据，但是在Swagger UI中，结果总是嵌套在application/json下 此here上有一个旧问题，但没有解决方法。 有没有人有解决这个问题的办法？我没有看到Swashbuckle的进一步更新(因此没有任何嵌入式Swagger UI)。
浏览 61提问于2020-11-11得票数 2
我正在尝试编写一个响应此http请求的方法。不幸的是，我不知道这种方法的论点应该是什么。 cat data.csv | curl --header "Content-Type: text/plain" --request PUT --data-binary @- http://localhost:8080/endpoint Swagger： put:
tags:
- "employees"
summary: "Stores employees hierarchy tree on server"
description: "
浏览 23提问于2021-04-23得票数 2
回答已采纳
1回答
我使用下面的代码创建了一个虚拟模型： #get the data
data(Boston, package="MASS")
# train a model for median house price as a function of the other variables
bos_rf <- lm(medv ~ crim + indus + dis , data=Boston)
# save the model
saveRDS(bos_rf, "bos_rf.rds") 现在我想使用plumber将这个模型公开为一个API。为此，我的代码是 # l
浏览 25提问于2020-04-16得票数 0
1回答
在我的安卓应用程序中，我试图通过restTemplate.exchange发出GET请求，但它经常导致400错误，很少是200响应。 GET request for "http://someURL/items/modified/2018-12-20T12%253A47%253A43%252B01%253A00" resulted in 400 (); invoking error handler org.springframework.web.client.HttpClientErrorException: 400 我试着用编码和解码的参数做请求，但这是相同的问题。唯一改变的
浏览 136提问于2018-12-21得票数 0
回答已采纳
1回答
我正在使用Spring Boot创建一个新的Rest API，使用Swagger来记录它，并且我不能更改web上显示的示例值。我可以在模型中更改它，但不能在POST参数中更改。
以下是我的依赖项：
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.4.RELEASE</versi
浏览 3提问于2019-05-02得票数 5
回答已采纳
我的API在Postman中正确地调用了work。但是，当我从Swagger UI发送请求时，它对所有请求显示“没有来自服务器的响应”：
反应体
无内容
响应码
0
响应头
{“错误”：“服务器没有响应”}
问题是什么，如何解决？
浏览器控制台显示以下错误：
加载资源失败: net::ERR_CONNECTION_REFUSED
未定义TypeError:无法读取未定义属性的“长度”
showStatus (index.js:24)
showErrorStatus (index.js:24)
规范下的index.js:607. ：533
Request.callback (
浏览 3提问于2017-08-01得票数 8
回答已采纳
我一直在努力解决openapi 3.0.1规范json文档中的一个问题。
我在online编辑器(editor.swagger.io)中看到的问题非常奇怪，POST的Request示例值部分没有显示"layers"，它是基于MixBase模式组件在MixBase模式组件中定义的数组。MixLayer架构组件有一个MixLayerComponent架构组件数组。但是，如果我在responses部分中包含了一个$ref到MixBase模式，那么所有的元素都会正确显示。
请求缺少“层”的正文示例值部分：
{
"mixId": "4f8b533f-7449-
浏览 5提问于2022-09-30得票数 0
2回答
我正在使用swagger创建一个非常简单的快速节点API的文档。我所有的响应主体都使用“数据”键，其格式如下：
{
"data": [items] // or a single item if it is the case
}
现在，我正在使用swagger-jsdoc来指定我的文档，我的响应规范如下：
* responses:
* 200:
* content:
* application/json:
* schema:
* type: array
* item
浏览 4提问于2022-07-22得票数 0
回答已采纳
我能够得到localhost:8080/v2/api-docs的json响应，但是当我试图在localhost:8080/swagger-ui.html上加载swagger时，它会显示没有api列出的swagger。
浏览 0提问于2019-03-24得票数 2
回答已采纳
我有一个控制器，可以接收邮政请求。
public IHttpActionResult PostCreaAlimento([FromBody] Alimento alimento)
{
if (!ModelState.IsValid)
return BadRequest("Invalid data.");
return _repositorio.CreaAlimento(alimento) ? Ok(alimento) : (IHttpActionResult)NotFound();
}
该请求在swagg
浏览 3提问于2021-11-23得票数 1
回答已采纳
我使用Swashbucket和Swashbucket.Examples NugetPackages在.NET框架(v.4.7.2)中提供Swagger API。 按照https://github.com/mattfrear/Swashbuckle.AspNetCore.Filters上的文档，我尝试使用SwaggerRequestExample属性，如下所示： [HttpPost]
[Route("search")]
[SwaggerRequestExample(typeof(OrderRequestExample), typeof(OrderRequestExamplePr
浏览 55提问于2020-06-09得票数 0
1回答
我在play框架模型中有以下case类，它在swagger-UI中错误地显示为数组。
case class ComponentAvg(@ApiModelProperty (value="..",
example="2.722", dataType="String")
value: String)
我想知道如何修复这样的响应类型将是ComponentAvg类型。
下面是swagger-UI示例中响应的显示方式：{ "value"："2.722“}
浏览 1提问于2018-10-22得票数 0
我们使用swagger UI来显示Spring MVC REST API请求响应。我有一个API将文件夹保存为zip。我想在swagger UI上显示下载状态。我该怎么做呢？任何帮助都是非常感谢的。或者如何在swagger UI中显示Zip文件下载状态？
浏览 1提问于2015-01-23得票数 1
2回答
在我们的项目(springMVC) Rest项目中，我希望只对请求和响应使用一个模型(为了避免添加大量代码将字段从一个对象复制到另一个对象)
我想用Swagger来处理所有的文档，但是我遇到了一个小问题。例如，假设我有一个模型用户
public class User {
private Long id;
private String username;
private String password;
}
和一个简单的控制器
public void createUser(@RequestBody User user)...
public User getUser(Long id)
浏览 2提问于2016-01-12得票数 1
我在用springdoc-swagger-ui。众所周知，Swagger无法处理大型响应，建议的解决方法是禁用Swagger中的语法高亮显示。
我试图为我的Spring应用程序在application.yaml中添加以下配置，但没有任何效果。我仍然看到反应是突出的。
springdoc:
swagger-ui:
syntax-highlight:
activated: false
关于如何在Swagger中禁用语法高亮显示的任何线索，请使用Springdoc或application.properties
浏览 1提问于2022-10-27得票数 0
1回答
我有一个与Swagger UI集成的REST API。但是，当我尝试从Swagger UI执行请求时，界面只显示curl命令，但不提供服务器响应。curl命令在从命令行运行时返回预期的响应，但UI本身没有显示任何内容。
我能做些什么来解决这个问题？
浏览 14提问于2017-07-18得票数 2
我在我的项目中集成了swagger用户界面。我需要传递令牌才能提出请求。
const mytoken = "heareismytoken";
const ui = SwaggerUIBundle({
url: "/swagger/v2/swagger.json",
dom_id: '#swagger-ui',
deepLinking: true,
requestInterceptor: function (req) {
var key = mytoken;
if (key &am
浏览 5提问于2020-03-27得票数 8
回答已采纳
我们正在使用swagger 2.0来记录我们的Azure Web，我们在Azure中托管在.Net API Management后面。我在获取文档以详细说明作为正文一部分发布的复杂对象时遇到了麻烦。Azure根本没有显示关于这个对象的任何细节，让我不得不自己记录它们。下面是我导入到Azure API管理中的json文件。
{
"swagger": "2.0",
"info": {
"version": "1.0.0",
"title": "Ho
浏览 2提问于2015-11-25得票数 4
我使用NelmioApiDocBundle v2.13.0来处理symfony 2项目，该项目基于Swagger 1.2女巫提供的符合Swagger的JSON定义，这是一个旧版本。我搜索了很多关于NelmioApiDocBundle对Swagger2.0的支持，但是没有任何好的响应。这些都是我发现的类型链接：
我想知道NelmioApiDocBundle是否支持Swagger2.0。如果有另一个包可以代替这个包。
浏览 2提问于2017-01-05得票数 2
回答已采纳
4回答
我通过Swagger 2.0 nuget pkg将我的解决方案更新到Swashbuckle。自更新以来，Swagger不再显示响应类的文档。我的控制器中仍然有我的路径，上面装饰着[ResponseType(typeof(MyObject))]，以前它会在swagger下面填充响应类部分，但是这似乎不再被接受了。我是不是在更新中遗漏了什么？
编辑：
这是我在更新后不再看到的
浏览 4提问于2015-03-11得票数 3
1回答
在API响应中自定义JSON属性
、、、、
我使用Spring，泽西和Swagger (io.swagger:swagger-jersey2-jaxrs:1.5.8)
我有一个JSON响应，作为对GET的响应返回，如下所示：
{"myText": "success"}
但是，我希望能够自定义响应中的属性，使其不同于它们的底层java重新表示。
{"My Own Text": "success"}
我不能使用“我自己的文本”作为Java属性，所以我将其存储为myText，但我希望以更“友好”的格式向客户公开它。我试过使用ApiModelProperty(name="M
浏览 1提问于2018-05-29得票数 0
回答已采纳
我是通过注释从swagger生成的。其中一个响应模型属性是int。Json模式将其显示为"totalResults":{ "type":"integer"，" format ":"int32“}我想从swagger中删除该格式。 根据swagger规范文档，整数可以有3种格式"-“、"int32”和"int64“Swagger definition snippet 是否存在删除格式或强制格式类型"-“的方法。我尝试了@ApiModelProperty注解，它显示了dataType的选项，但
浏览 42提问于2020-04-28得票数 0
我正在使用kotlin中的ARest框架设置一个由GET、DELETE和POST方法API组成的新服务。 我将输入包装在一个数据类中，并将其传递给方法。在这种情况下，DELETE和POST方法可以很好地工作，但我在使用GET方法时遇到了一些问题。 用于包装输入的数据类： class GetRequest(@QueryParam("aaa") var aaa: String? = null,
@QueryParam("bbb") var bbb: String? = null,
浏览 19提问于2019-04-03得票数 1
我正在为ASP.net API创建swagger文档。我想在swagger中显示，对于任何给定的状态代码，都没有响应(除了状态代码)。我的方法有以下属性： ? 这给了我在swagger中的以下结果： ? 正如你所看到的，状态码200和500没有响应类型，这就是我想要的。但是401有不必要的响应类型。我想摆脱它。所有其他状态代码( 200和500除外)也是如此。我尝试添加EmptyResult，但仍然会产生空方括号作为响应： ? ? 你知道我该如何配置它吗？我在使用Swashbuckle。
浏览 36提问于2020-07-07得票数 0
回答已采纳
当我使用package api在OLP上创建一个~50mb的jar包时，我收到一个错误{"status":400,"code":"E9999","message":"HTTP 400 Bad Request","messageTemplate":"{unknown.error}","templateOptions":null,"errors":[]} 错误代码未在此处列出，https://developer.here.com/olp/document
浏览 15提问于2019-04-23得票数 1
1回答
我让swagger (docker: swaggerapi/swagger-ui)在swagger.mydomain.com上运行，对在a.mydomain.com和b.mydomain.com上运行的api服务器有两个定义。 A和b都是flask (python)服务器。由于在第四个子域上提供set应用程序，a.mydomain.com已经建立了一段时间的CORS。这在该子域名和swagger中都工作得很好。现在我为b.mydomain.com做了同样的CORS设置，但是没有成功。 两台服务器上的设置如下所示： from flask import Flask
from flask_cors
浏览 33提问于2021-09-17得票数 3
回答已采纳
例如，在body part.Can中，我做了一些事情，让我在structure1和structure之间做出选择，就像在enum.Here中一样，这也是我的结构和结构。我们有像选择器这样的东西吗，或者每次我都应该为每个结构创建新的POST或PUT ?可能还有其他方法来处理if ?我们在swagger中有if吗？
openapi: 3.0.0
servers:
- url: 'http://petstore.swagger.io/v2'
x-origin:
- url: 'http://petstore.swagger.io/v2/swagger.json&#
浏览 1提问于2017-08-30得票数 1
在Swagger文件中，默认情况下这两种响应格式都包括JSON:API和application/json。
这会导致生成Java类时出现问题，并阻止客户端编译。
我用两个不同的编译器测试了这个
Swagger代码生成器3.0.35 以及
不同版本的OpenAPI生成器。
作为解决办法，Swagger文件目前必须手动调整，JSON:API格式必须删除，这将导致更新期间的大量工作。
Swagger文件的生成是否可能只包含格式应用程序/json
浏览 1提问于2022-10-17得票数 0
回答已采纳
我使用了带有examples块的swagger YAML来实现请求和响应的示例结构。类似于的东西。我的问题是，该规范在本地swagger UI文档中运行良好，但是当该YAML部署到gcloud端点时，它不会显示examples块。
我所期望的是google cloud端点向我展示响应的示例，类似于我们为paypal、stripe和其他平台提供的文档，这些平台的文档中也有显示API响应的示例值的空间。
浏览 1提问于2019-08-16得票数 0
套餐：
hapi-swagger: 9.0.1
joi: 13.0.2
背景：
我将swagger-ui与hapi-swagger生成的swagger.json文件一起使用。
我使用设置为hapi-swagger的jsonEditor选项true。这意味着我没有在单个文本区域中输入主体，而是直接使用UI生成的输入。
发行：
在有效负载中只需要键"name"，如果我引用Joi文档，其他的默认是可选的。
实际上，Swagger-UI发送：
curl -X POST
--header 'Content-Type: application/json'
--header
浏览 7提问于2018-01-03得票数 3
回答已采纳
对于Swagger v2.1.4，我有一个非常奇怪的行为：
当我从服务器返回带有HTTP内容类型标题"text/html“的JSON文档时，在Swagger中一切都很好。
但是当我用HTTP头"application/ JSON“返回相同的json文档时，我会在控制台中得到一个”无法加载SwaggerUI“错误。
(然后在Swagger中，我有一个常见的错误消息：“无法从服务器读取。它可能没有适当的访问控制源设置。”)
我仔细检查了两个HTTP响应(工作响应和失败响应)的所有细节，这是唯一的区别。
这很遗憾，因为设置这个"application/json“内容类型可以帮
浏览 1提问于2016-03-30得票数 1
回答已采纳
1回答
我正在使用来验证一个小型API服务器的输入(使用Swagger 2格式)。
我的path定义如下
/api/v1/users:
post:
produces:
- "application/json"
parameters:
- in: body
name: ids
description: Array of user ids to be processed
required: true
schema:
$ref: "#/definitions
浏览 21提问于2018-09-05得票数 1
回答已采纳
我目前正在一个代码库中工作，对于每个REST响应，它们都使用一个java类，如下所示
{
Object payload;
List<Error> errors;
String responseStatus;
}
问题是，当我们引用REST的swagger文档时，它显示了如下所示的json结构。
{
"payload":{},
"errors": [
{
"errMsg":"",
"errCode": ""
}
],
"respons
浏览 5提问于2021-12-15得票数 3
我在我的OpenApi项目中使用SpringBoot 3来生成Swagger页面。
POM.xml中的依赖项：
<dependency> <groupId>org.springdoc</groupId> <artifactId>springdoc-openapi-ui</artifactId> <version>1.5.12</version> </dependency>
在Controller类中，我在方法上面定义了以下注释。
@Opera
浏览 5提问于2021-11-11得票数 0
2回答
我使用Swashbuckle和Swagger自动生成API文档。
My端点使用以下PersonViewmodel：
public int? ID { get; set; }
public string Name { get; set; }
我的端点方法以PersonViewmodel作为主体，并使用IActionResult返回一个PersonViewmodel。但是，我不希望用户定义一个ID，因为它是由业务逻辑生成的。在代码中，如果设置了ID，则忽略该ID。
如何更改Swagger以不显示主体输入的示例值中的ID，但仍然显示响应的示例值的ID？
我发现了许多方法可以从Swagger中完全删除
浏览 6提问于2021-10-21得票数 0
我正在为现有的API实现一个swagger文档，但我无法解决的是如何在swagger-ui中显示json响应。我使用的是Swagger1.1。我的Json反应是这样的。
"currentLocation": {
"timestamp": "2015-12-10 07:12:38"
"altitude": 34
"longitude": 78
"latitude": 44
"accuracy": 1000
}
浏览 2提问于2015-12-10得票数 0
我尝试用Swagger指定GET方法的响应。但是当我查看Swagger时，JSON没有显示响应。
我的宣言是傲慢的：
/clients/{id}:
get:
consumes:
- application/hal+json
produces:
- application/hal+json
# This is array of GET operation parameters:
parameters:
# An example parameter that is in query and is required
- name: id
浏览 0提问于2015-06-18得票数 0
我已经使用Swashbuckle将swagger集成到了一个dot.net核心应用程序接口应用程序中。当我在没有提供凭证的情况下通过Swagger UI执行一个API时，它会像预期的那样返回一个"401- Unauthorized“响应。 但它没有显示错误响应，我已将其配置为作为正文作为自定义错误响应返回。它会返回标题，如下图所示。 当我通过Postman执行相同的API时，它确实返回自定义错误响应，如下所示。 我需要的是，我还需要在swagger UI中看到自定义错误响应正文。 在邮递员中， ? 在斯威格， ? 使用403和404状态代码的情况相同。
浏览 45提问于2021-07-27得票数 0
Swagger 在UI和JSON中没有显示参数，甚至我的方法都有参数，尤其是当我添加FromBody标记时
行动方法：
[HttpPost("Action")]
public IActionResult Action([FromBody] string message)
{
return Ok(message);
}
我使用了新的Asp.net核心3.1和2.2 web应用程序和API模板来测试这一点，我把它配置得与完全一样
ConfigureServices：
services.AddMvc();
services.Ad
浏览 3提问于2020-03-07得票数 1
回答已采纳
例如，在不同的包中有两个同名的类Group。但是，当在swagger ui中引用模型时，只显示一个模型，甚至响应映射也不正确，swagger错误地引用了这些模型。
浏览 108提问于2020-12-14得票数 0
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
实时音视频
即时通信 IM
对象存储活动推荐
腾讯云开发者
