我正在为一个项目设计一个openAPI规范。该项目是一个REST API，提供有关酒店的信息。 我想提供有关酒店的详细信息，或者提供一个简短的摘要。我对REST的理解是，由于这两者都与我的数据存储中的同一对象相关，因此我应该使用查询参数来请求不同的数据类型。 因此，我所寻找的是一种基于给定请求的查询参数来指定不同API行为的方法。如果为detail=robust，则响应应如下所示： {
"name": "Hilton
浏览 19提问于2020-08-31得票数 1
回答已采纳
1回答
我在view.py模块中有这个api：def get_all__referralCodes_game(request):http.HTTPStatus.OK)在url.py模块中，我有：
urlpatt
浏览 6提问于2021-12-28得票数 0
回答已采纳
1回答
在OpenAPI v3中定义接口时，如果多个接口路径使用相同的查询参数列表，有没有办法一次定义它们并在每个路径中引用它们？想象一下一个常见的场景，我有5个不同的API用于搜索，但它们都共享相同的查询参数，如“限制、书签、页面、排序”等。对可能的重复项的响应
我问的不是一次引用一个特定的参数，而是在几个API路径中重用一组参数。因
浏览 2提问于2020-07-28得票数 3
OpenAPI生成器用于代码生成。根据的“返回文件的响应”部分，响应的模式可以定义为带有format: binary的type: string。然后，生成的接口将类似于：CompletableFuture<ResponseEntity<org.springframework.core.io.Resource>> downloadFile()。我们如何为ResponseEntity指定另一种主体类型？(例如中描述的StreamingResponse
浏览 75提问于2021-05-19得票数 0
对于我们的REST，我们有一些HTTP请求报头，这些报头将由基础架构组件设置，并且不应该在OpenAPI规范中发布给消费者。在我们构建的基于Spring Web的实现代码中(实现openapi生成器生成的接口)，从HTTP请求中检索类似内容的正确方法是什么？例如，未在接口上指定的标头。我在openapi生成器本身中看不到任何将HttpServletRequest作为参数添加到生成的方法中</
浏览 2提问于2020-04-21得票数 1
我有一个GET路由，我想在其中将url中的对象参数编码为查询字符串。在编写swagger文档时，我基本上得到了不允许我在query类型参数中使用schema/object类型的错误： /mypath/: parametersproperties: type: string具有对象值的请求查询</e
浏览 4提问于2016-07-04得票数 13
回答已采纳
我有一个HTTP302(重定向)，它实现了一个新的状态参数，它将附加到RedirectURL中，因此可以显示如下所示的消息GET http://localhost:8080/infostatus=error
但是如何在OpenAPI规范中描述这一点呢？我似乎无法在响应中使用parameters，并且找到了一些使用responseParameters的代码，但是我没有运气让它工作。
浏览 1提问于2020-09-08得票数 10
1回答
根据在其博客中的建议，我希望实现字段查询字符串参数，以允许移动应用程序客户端限制从单个RESTful应用程序接口调用返回的内容。fields=name,id,age
如果省略fields参数，则将返回完整的account资源。我的问题是，我如何使用Jersey在服务器上实现这一点(例如)。因为Jersey使得返回一个Account POJO变得很容易，但是我不确定如何根据‘field’查询字符串参数
浏览 0提问于2012-06-12得票数 0
回答已采纳
ApiController允许我们根据传入的查询参数区分两个不同的GET操作。当我试图在APIM中定义这些端点时，我会得到以下错误：该消息表明端点仅由路径和操作定义。但这似乎与我发现的文档相矛盾，该文档表明，有一种方法可以根据查询参数区分操作：
路径和查询所需的参数必须有唯一的名称。(在OpenAPI中，一个参数名只需要在一个位置<
浏览 0提问于2019-02-19得票数 1
回答已采纳
在openapi规范中，我为特定的资源路径指定URL参数，如下所示： /some/path: summary: some summary default ResponseEntity<Object> somePathGet(String使用{@li
浏览 3提问于2020-09-03得票数 0
我一直在尝试使用多个查询参数(简单分页)来执行Restangular，这似乎是不可能的--至少我正在尝试这样做。pageParam: page, pageSizeParam: pageSize }).then(function(data) {});
错误: getList的响应</em
浏览 0提问于2015-04-29得票数 4
根据Swagger send body and formData parameter和OpenAPI 2.0 Specification的规定，在OpenAPI 2.0中，对于同一操作，in: body和in: formData参数不能同时存在。但是我使用的是OpenAPI 3.0，我想知道是否有一种方法可以根据路径参数来切换requestBody？
浏览 48提问于2019-12-08得票数 1
回答已采纳
我请求(通过Accept: application/json)我正在设计的一个应用程序接口响应为JSON。但是，我希望根据客户端的功能将该JSON中的值指定为符合text/plain或text/html。
“子类型”的RESTful最佳实践是什么？如果我正式切换到HAL作为顶级容器，这将如何工作？
浏览 2提问于2012-10-25得票数 1
我正在检查一些现有的代码，在yaml文件中我发现了下面提到的两个参数 in: "query" required: true type: string我真的无法理解这些参数in: "query"
浏览 1提问于2021-12-01得票数 0
回答已采纳
我试图将以下JSON映射到OpenAPI 2.0 (Swagger2.0) YAML定义，并且我不知道如何将混合数组类型设置到我的模式中： "obj1": [ 1}schema: type: array type: string
但这不允许数组中的整数
浏览 2提问于2016-08-01得票数 14
回答已采纳
在设计RESTful应用程序接口时，如果GET请求只有在存在与该请求关联的特定参数时才有意义，该怎么办？参数是否应该作为查询字符串传递，如果是这样，当所有参数都没有指定或格式不正确时该怎么办？每个帖子都有一个地理位置，只有在指定帖子可能驻留的区域时，才能检索帖子。因此，需要3个参数:纬度、经度和半径。将参数放入查询</
浏览 0提问于2015-02-19得票数 26
回答已采纳
根据Google Drive API v3，应该返回文件的完整元数据，例如：{ "id": "string", "mimeType": "application/pdf"如果响应是这样的，我需要使用这个接口的V2。
浏览 0提问于2017-05-27得票数 0
嗨，我在一个功能上工作，在它我想上传的文件从系统到谷歌云桶，这是一个魅力工作，但我无法想出一种方法，以获得从云桶的响应代码，当文件已成功上传到云上。有人可以建议我如何才能拿回响应代码时，文件上传成功，我是附加的代码片段，以便更好的调试
private void uploadtobucket(List<MultipartFile> selectedfile
浏览 1提问于2020-09-22得票数 0
云服务器
ICP备案
对象存储
云点播
实时音视频
腾讯云开发者
Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有
深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 
粤公网安备44030502008569号
腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号