如何在OpenAPI (Swagger)中定义一个接受任意对象数组的参数？
在OpenAPI（Swagger）中定义一个接受任意对象数组的参数，可以使用type: array和items关键字来实现。下面是一个示例：
parameters:
- in: body
name: data
description: 要传递的对象数组
required: true
schema:
type: array
items:
type: object在上面的示例中，我们使用parameters关键字定义了一个参数，它的位置是body，名称是data，描述了要传递的对象数组。required属性指示该参数是否是必需的。
在schema中，我们使用type: array来指定参数的类型为数组，然后使用items关键字来定义数组中元素的类型。在这个示例中，我们将元素类型定义为object，表示可以接受任意对象类型的数组。
这样定义的参数可以用于描述接口的请求参数或响应参数。在实际使用中，可以根据具体需求进一步定义对象的属性和类型。
推荐的腾讯云相关产品：腾讯云API网关（API Gateway），它是一种全托管的API管理服务，可以帮助开发者更轻松地构建、发布、运行和维护API。您可以通过以下链接了解更多信息：
腾讯云API网关产品介绍：https://cloud.tencent.com/product/apigateway
相关·内容
我使用go-swagger openAPI来生成REST客户端。 现在，我想将响应大小限制在最大值，例如1MB。在Go中，这意味着在使用响应的正文时使用LimitReader。 有没有办法也用go-swagger openAPI来限制响应大小？
浏览 50提问于2021-02-11得票数 3
1回答
我正在编写一个OpenAPI (Swagger)定义，其中查询参数可以不带任何值，或者N个值，如下所示：
/path?sort=field1,field2
我如何用OpenAPI YAML来写这个？
我尝试了以下方法，但没有产生预期的结果：
- name: sort
in: query
schema:
type: string
enum: [field1,field2,field3]
allowEmptyValue: true
required: false
description: Sort the results by attributes. (See
浏览 1提问于2018-05-25得票数 10
回答已采纳
在REST API中，我希望使用哈希图Map<Foo, List<Bar>>，其中Foo和Bar是用户定义的类。如何在OpenAPI (Swagger)中描述这样的地图？
浏览 0提问于2018-06-29得票数 2
在Swagger和OpenAPI规范中，我看到了在查询参数中定义数组的多种方法。下面所有的例子都是有效的吗？是否有更有效的选择？
示例1：
...
{
"name": "example",
"in": "query",
"type": "array",
"items": {
"type": "string"
}
}
...
示例2：
...
{
"name": "e
浏览 2提问于2021-08-12得票数 1
回答已采纳
我试图将以下JSON映射到OpenAPI 2.0 (Swagger2.0) YAML定义，并且我不知道如何将混合数组类型设置到我的模式中：
{
"obj1": [
"string data",
1
]
}
现在，我的OpenAPI定义有：
schema:
object1:
type: array
items:
type: string
但这不允许数组中的整数。
是否有方法定义混合类型数组？
浏览 2提问于2016-08-01得票数 14
回答已采纳
1回答
我试图迫使dry-yasg正确地解析路径中的参数。假设我们有
path('users/<int:user_id>/', whatever.as_view(...))
在swagger文档中，它不被视为int，而是string。
我用过
swagger_auto_schema(manual_parameters = [
openapi.Parameter(
name,
openapi.IN_PATH,
description=desc,
type=openapi.TYPE_INTEGER,
浏览 5提问于2020-05-07得票数 2
回答已采纳
我正在使用带有Spring Boot的，我希望有像这样的Swagger交互式文档。
我可以从AWS Lambda动态提供它，或者在编译期间生成OpenAPI规范，然后将其上传到AWS S3。
不幸的是，当我添加到build.gradle时：
compile('io.springfox:springfox-swagger2:2.7.0')
compile('io.springfox:springfox-swagger-ui:2.7.0')
并将此配置代码添加到SwaggerConfiguration类：
@Configuration
@EnableSwagger2
浏览 0提问于2018-04-29得票数 0
我在上跟踪openapi的micronaut，并且UI没有生成，每次我试图访问/swagger时，/swagger-ui都会出现以下错误：
{
"message": "Not Found",
"_links": {
"self": {
"href": "/swagger",
"templated": false
}
},
"_embedded": {
"errors": [
{
浏览 7提问于2022-10-21得票数 2
回答已采纳
1回答
我在将swagger设置到我的node.js应用程序时遇到了问题。我使用swagger-jsdoc和swagger-ui-express创建文档。这是版本
"swagger-jsdoc"："3.5.0"，"swagger-ui-express"："4.1.3“
下面是我传给斯威格-jsdoc的吐露。
openapi: 3.0.0
info:
description: test
version: 3.0.0
title: U-CRM api documentation
termsOfService: http://s
浏览 3提问于2020-02-17得票数 1
我有一个端点，它的查询参数使用了方括号：
GET /info?sort[name]=1&sort[age]=-1
这里，name和age是我的模型定义中的字段名。
如何为这些参数编写OpenAPI (Swagger)定义？
浏览 9提问于2018-01-29得票数 8
回答已采纳
例如，在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
我正在开发一个应用程序，它使用库为其Spring控制器生成OpenAPI v3端点。这个库使用来实际将OpenAPI对象映射到OpenAPI模式。
控制器使用的请求/响应类型包括Object类型的属性。
public class TypeWithObject {
private Object value;
public Object getValue() { return value; }
public void setValue(Object value) { this.value = value; }
}
因此，这种类型可以是OpenAPI定义的任何OpenAPI
浏览 1提问于2021-09-20得票数 1
1回答
我正在为我的项目构建一个OpenAPI支持，但我需要swagger.yaml文件只对授权用户可用。
Swagger和Swagger似乎都希望swagger.yaml文件可以公开访问。
我想过各种绕过它的方法。可以使用“签名”URL，类似于S3的方式--只有有链接的人才能访问它。
什么是好做法？
浏览 1提问于2016-06-07得票数 1
回答已采纳
我已经将我的Jersey REST Service文档升级到swagger openapi v3。
现在，我想介绍一个根据用户授权过滤方法的方法，以便只在swagger-ui/ openapi.yaml文档中显示特定的API方法。我最接近的方法是使用一个扩展io.swagger.v3.core.filter.AbstractSpecFilter的过滤器类ApiAuthorizationFilterImpl。
public class ApiAuthorizationFilterImpl extends AbstractSpecFilter {
@Override
pu
浏览 25提问于2020-12-14得票数 1
我正在从swagger 2迁移到OpenApi 3。
Swagger 2示例代码
@ApiOperation(value = "", nickname = "")
@GetMapping
public List<Employee> findEmployees(@Valid Dto dto) {
return employeeService.findEmployees(dto);
}
OpenApi 3代码
@Operation(summ
浏览 9提问于2020-04-17得票数 5
回答已采纳
我需要为搜索API定义swagger/OpenAPI v3.0文件。我的请求可以指定地理空间坐标(经度和纬度)或(邮政编码和国家代码)或(城市、州和国家代码)。除此之外，我还有两个强制性属性，如distanceUnits.和#en0#。
我知道如何在JSON模式中实现它
"dependencies": {
"postalCode": ["countryCode"],
"city": ["state", "countryC
浏览 8提问于2021-09-13得票数 1
回答已采纳
我创建了一个返回数组的项目。导入此swagger.json后，查看swagger.json一切正常。但是，当我从开发人员门户下载API定义时，我看到一些对象，如...Array、...数组-1、...数组-2。我没想到会这样： ? 我如何防止这种情况发生？如何才能确保生成的对象与正常对象的行为相同(所以没有虚线，而是点)。我创建了一个重现我的问题的示例项目：https://github.com/mvdiemen/SwaggerArrayGenerationExample。 这是否与此处描述的Azure API管理中的更改有关？：https://blog.tomkerkhove.be/
浏览 14提问于2019-09-05得票数 0
回答已采纳
在OpenAPI (Swagger) 2.0中，我们可以这样定义头部参数：
paths:
/post:
post:
parameters:
- in: header
name: X-username
但是在OpenAPI 3.0.0中，参数被请求主体替换，我找不到一种方法来定义头参数，这些参数将进一步用于身份验证。
在OpenAPI 3.0.0中定义请求头的正确方式是什么？
浏览 3提问于2018-05-01得票数 18
回答已采纳
1回答
我对Swagger对OpenAPI3.0的枚举支持感到有点困惑。我在这里的观点是，swagger文档有了新的改进，支持可重用的枚举，如下所示：
其中对可重用枚举的支持是使用$ref声明的。但是，当我将我的swagger.json发布到swagger编辑器/验证器时，它看起来像下面这样
in: query
name: prop-name
description: something
type: array
items:
$ref: '#/definitions/mytype'
浏览 34提问于2020-05-15得票数 0
回答已采纳
我有一个用于OpenAPI 3的JSON文件，它包含以下内容：
"trait_hasProjectResponse_200": {
"description": "",
"content": {
"application/xml": {
"example": {
"
浏览 0提问于2019-02-27得票数 0
回答已采纳
x_param = openapi.Parameter('x', in_=openapi.IN_FORM, description='srring',
type=openapi.TYPE_STRING)
y_param = openapi.Parameter('y', in_=openapi.IN_FORM, description='string',
type=openapi.TYPE_S
浏览 12提问于2018-06-19得票数 25
我正在为我的API编写一个OpenAPI定义。我使用components作为响应，但是Swagger在尝试引用以下组件时显示了一个错误：
引用响应组件的正确方法是什么？
浏览 3提问于2021-09-14得票数 2
回答已采纳
我想通过url /v3/api-docs/设置默认方案，但有空的url和错误“没有API定义提供。”我应该使用哪些设置属性？
项目中的当前代码：
application.properties
springdoc.swagger-ui.disable-swagger-default-url=true
springdoc.swagger-ui.use-root-path=true
SwaggerConfig.java
@Configuration
public class SwaggerConfig {
@Bean
public GroupedOpenApi applicationApi() {
浏览 24提问于2021-05-24得票数 0
1回答
我是OpenAPI的新手，我需要一些帮助为贝宝的创建一个基本的swagger文件，以便从我们的平台创建一个支付。注意事项：OAuth已经配置好了。
下面是一个基本的swagger文件，但我不知道在哪里添加 (即意图、支付者、交易等)。转入：
{
"swagger": "2.0",
"info": {
"description": "this is a payment request to through PayPal",
"title": "Swagger PayPa
浏览 1提问于2017-02-20得票数 1
有谁知道如何在Swagger 2.0定义中定义可能的'enum‘值，以便它们显示在OpenAPI UI的模型选项卡中？示例如下:对于status属性，有一个枚举选项。如何在OpenAPI 2.0中定义这样的枚举？
浏览 1提问于2014-12-22得票数 62
所以我有一个spring boot项目，我刚刚在其中添加了OpenAPI Swagger UI。它可以很好地自动为我们所有的控制器和模型生成文档。但是我想添加一些额外的配置，比如externalDocs，如下所示。 externalDocs:
url: URL
description: DESC 但是因为它是自动生成的，所以我没有用于swagger的YAML。我尝试通过Bean添加它，但没有成功。 import io.swagger.v3.oas.models.ExternalDocumentation;
import io.swagger.v3.oas.models.Ope
浏览 50提问于2020-08-25得票数 0
回答已采纳
1回答
在Swagger/OpenAPI 3.0中，可以重用枚举定义？
示例-共享颜色枚举定义：
openapi: 3.0.0
info:
description: "This is a sample server Petstore server. You can find out more about Swagger at [http://swagger.io](http://swagger.io) or on [irc.freenode.net, #swagger](http://swagger.io/irc/). For this sample, you can
浏览 7提问于2018-07-30得票数 1
回答已采纳
问题
根据和，Swagger支持复杂的参数，但是当我试图描述json参数时，Swagger显示了以下问题：
无法呈现ParameterRow，请参阅控制台。
期望行为
对象作为参数。
YAML
openapi: "3.0.0"
info:
version: 1.0.0
title: Trackmeeasy API
paths:
/getLabelUrl.action:
post:
parameters:
- in: query
name: filter
content:
浏览 0提问于2018-07-30得票数 2
回答已采纳
下午好。我试图在Quarkus中使用Swagger，在本地，它对我来说很好，但是当我将它上传到生产环境时，我在Kubernetes集群中将它用作反向代理，遇到了一个问题，我不允许您查看Swagger界面：
本地邮递员：
斯瓦格地方：
邮递员Kubernetes环境与Ingress Nginx：
斯瓦格-Ui在库伯奈特斯环境中的攻入-Nginx：
我的application.properties：
quarkus.datasource.db-kind=oracle
quarkus.datasource.jdbc.driver=oracle.jdbc.dri
浏览 6提问于2022-06-20得票数 0
回答已采纳
2回答
使用OpenApi的实际优势是什么？
我是openApi技术的新手，我只是想知道在openApi中有哪些特性比在swagger中有更多的特性。网上文件帮不了我。有人能帮我吗。
浏览 2提问于2020-04-03得票数 9
回答已采纳
我遵循OpenAPI (swagger)规范来定义我的API端点。这是获取用户数据的端点定义的摘录：
"paths": {
"/users/{id}": {
"parameters": [
{
"name": "id",
"in": "path",
"description": "The user ID on which the operation will be executed.
浏览 4提问于2016-12-13得票数 3
1回答
我正在为各种APi的文档创建swagger文件。在控制器中，我请求一个RequestParam和一个RequestBody：
@PostMapping("/message-now/save-with-params")
@Timed(value = MetricsTimerConstants.storeMessageWithParamsTimer)
public ResponseEntity<Object> saveMessageWithParams(@RequestBody Map<String, Object> request,
浏览 2提问于2020-12-04得票数 6
回答已采纳
在我的春季引导应用程序中，在应用程序启动时，我正在生成多个json格式的swagger文档，并存储在位置-静态/标记文件。我能够通过在application.properties中提到路径来读取文件，如下所示
application.properties
springdoc.swagger-ui.urls[0].url=/swaggerdoc/openapi.json
springdoc.swagger-ui.urls[0].name=openapi
springdoc.swagger-ui.urls[1].url=/swaggerdoc/openapi1.json
springdoc.sw
浏览 6提问于2022-01-26得票数 1
回答已采纳
我正在使用DRF-YASG在Swagger中记录API，并希望自定义/消除参数中显示的一些字段 我使用Django 2.1.7、DRF 3.9.2和DRF-YASG 1.14.0运行该项目。 因此，我想删除swagger-ui中显示的ID (像'string‘和'path')，因为我通过Schema将它放在请求主体中，但是swagger-ui在参数中显示id (自动生成的字段)。 在下面的屏幕中，您可以看到问题： https://user-images.githubusercontent.com/5421182/54859641-70359d00-4cee-11e9-
浏览 51提问于2019-03-24得票数 2
1回答
据说，“要定义cookie身份验证，应该使用API密钥。”在正式文件中
事实是我们试过
components:
securitySchemes:
cookieAuth:
type: apiKey
in: cookie
name: sessionId
...
security:
- cookieAuth: []
使用上面的代码，在Swagger中，我们可以单击挂锁来设置sessionId的值。但是当我们执行该方法时，-- cookie的值为NULL，并且我们看不到在Header (Chrome工具)中发送的c
浏览 1提问于2018-03-14得票数 11
我希望将我的自定义javascript文件或代码加载到FastAPI Swagger网页中，以便在创建FastAPI对象时添加一些动态交互。
例如，在docs网页上的Swagger中，我想
<script src="custom_script.js"></script>
或
<script> alert('worked!') </script>
我试过：
api = FastAPI(docs_url=None)
api.mount("/static", StaticFiles(directory
浏览 16提问于2022-12-02得票数 2
我试图为SecurityDefinition构建Swagger设置，以便在openapi.json中获得以下结果：
"securityDefinitions": {
"password": {
"type": "oauth2",
"tokenUrl": "http://example.com/oauth/token",
"flow": "password",
"scopes": {
"write&
浏览 7提问于2017-01-20得票数 6
回答已采纳
我正在为下面的OpenAPI有效负载构建一个XML ( Swagger ) 2.0定义，以便在Swagger UI中使用：
<addressElement>
<key type="RECORD_ID" item="3">Enter value here</key>
</addressElement>
我在弄清楚如何显示元素key的默认值“Enter value here”时遇到了一个问题。在OpenAPI定义中，应该将此默认值放在何处？我的定义是这样的：
"definitions":
浏览 1提问于2019-01-13得票数 3
1回答
Hi。
我有这个最简单的快速图服务器。
我想使用sofa-api使它“可休息”。
两个问题：
当你去/api/hello的时候，它应该是"Hello！“，现在它是空的。/graphql路由确实正常工作，并返回"Hello！“。
其余的swagger接口不在/api加载。
你可以在这里玩：
var schema = buildSchema(`
type Query{
hello:String
}`);
const openApi = OpenAPI({
schema,
info: {
title: 'Example API'
浏览 9提问于2022-11-20得票数 0
无法生成包含多部分/表单数据内容类型的swagger文件
描述
我有一个上传文件的请求，在那里我发送多部分/表单数据的文件。我试图将表单数据描述为
这就是我在邮递员中的要求。
当我试图生成一个swagger文件时。它给出了以下错误drf_yasg.errors.SwaggerGenerationError:当请求有请求体时不能添加表单参数；您忘记在视图上设置适当的解析器类了吗？
最小再生产
@swagger_auto_schema(
operation_id='Create a document',
operation_descr
浏览 8提问于2022-01-25得票数 0
我有一个包含以下URL的API：
/api/doSomething?key=value1=value2
这可以在Swagger/OpenAPI 3.0中表示吗？如果是这样，那会是什么样子呢？如果没有第二个value2，我会这样指定它：
/api/doSomething:
get:
summary: ''
parameters:
- in: path
name: key
description: ''
required: true
schema:
浏览 0提问于2018-08-23得票数 0
我有一个需求，我需要在我的微服务中有一个返回io.swagger.v3.oas.models.OpenAPI文档的GET端点，我想知道如何组合这个对象。原始形式的对象如下所示： {
"openapi": "3.0.1",
"info": {
"title": "MY API",
"description": "API for accessing stuff and other stuff.",
"termsOfService": "http://websit
浏览 45提问于2020-03-27得票数 0
回答已采纳
我已经使用Java项目的pom文件中的以下构件安装了swagger-ui：
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-ui</artifactId>
<version>1.5.2</version>
</dependency>
<dependency>
<groupId>org.springdoc&l
浏览 5提问于2021-01-21得票数 3
我已经在外部安装了swagger，我只是想将swagger-ui (开放源码)实例连接到openapi.yaml的localhost:8000/doc/api (openapi.yaml)。有什么想法吗？PS :我试着用
@Bean
public OpenAPI customOpenAPI() {
return new OpenAPI()
.components(new Components().addSecuritySchemes("basicScheme",
new SecurityScheme().
浏览 3提问于2020-10-14得票数 0
回答已采纳
使用Open API 3时如何设置自定义头部？我使用的是Spring Boot + springdoc-openapi-ui示例。在这个例子中，我希望在请求中传递不同的头。下面的配置没有显示用于选择客户标题的选项。 我还需要改变什么？ @Bean
public OpenAPI customOpenAPI(@Value("${springdoc.version}") String appVersion) {
return new OpenAPI()
.components(new Components().addSecuritySchemes("basic
浏览 36提问于2020-01-21得票数 1
回答已采纳
在Springboot项目中，我将从springfox迁移到OpenApi3，因为我们需要用2.7.0版本升级到最新的springboot
我需要为不同的环境配置自定义contextPath，如下所示
dev -
qa -
uat -
// pom.xml
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<versi
浏览 20提问于2022-06-06得票数 0
如何使用Swagger记录GraphQL？我们有一个庞大的后端REST API，最近部分开始使用GraphQL。为了记录API，我们使用Swagger。
问题是:如何使用Swagger(OpenAPI)来记录GraphQL端点？在Swagger或GraphQL的官方文件中绝对没有相关信息。
浏览 4提问于2020-09-11得票数 14
1回答
我使用openapi 3.0.1定义了一个查询参数，如下所示
{
"name" : "sort",
"in" : "query",
"description" : "Sorting criteria. Example: productCode,desc",
"required" : false,
"explode" : false,
"schema" : {
"type" : "array"
浏览 3提问于2021-12-21得票数 1
1回答
我有一个yaml文件：
openapi: 3.0.1
info:
title: My API
version: v1
paths:
# /users;id=3;id=4?metadata=true
/users:
get:
parameters:
- in: query
name: offset
schema:
type: integer
description: The number of items to skip before starting to c
浏览 0提问于2019-12-09得票数 1
我使用的包是
我目前通过执行以下命令生成swagger文件：
./ storage /bin/openapi--输出存储/app/swagger/swagger.json--排除测试--排除存储--排除供应商。
我有一些在多个用户之间共享的模型，所以我希望swagger模式定义能够与这些模型一起使用
./vendor/utilities/php-general-tools/src/models/
所以我需要包括那个文件夹，但它目前被排除在外..。显示的错误是
$ref "#/components/schemas/" not found for @OA\JsonC
浏览 0提问于2018-11-27得票数 0
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
实时音视频
对象存储
即时通信 IM活动推荐
腾讯云开发者
