openapi相关内容

整个响应的声明在swagger-php中可以重复使用吗?

我希望有一种方法来声明对每个终结点都相同的一些响应;例如,如果您没有正确的令牌,每个终结点将输出401,如果您的路径开头没有有效的id,则可能有另一组终结点都将输出id。 因此,对于几乎每种方法,我发现自己复制粘贴的内容如下: * @OAResponse(response=401, description="If no token..."), * @OAResponse(respons ..
发布时间:2022-08-16 13:25:33 其他开发

Swagger-UI-Open API 3,多部分/表单数据数组问题

我正在使用带有OpenApi 3.0.2规范的swagger-UI。 我设置了一个包含多部分/表单数据内容的questBody。 当我从swagger-ui执行请求时,一切正常,但是... 如果我添加一个数组类型的参数,它将在cURL调用中转换为这样的方式: -F "tags=my,tag" 我需要分解数组 -F 'tags[]=my' -F 'tags[]=tag' 我查看 ..
发布时间:2022-08-16 13:01:16 其他开发

模型表单-YAML文件中使用Swagger 2.0的数据体请求

我使用的是swagger 2.0,我有一个终结点,它使用表单数据作为请求的有效负载,我在几个地方使用相同的表单数据主体请求,我不想一次又一次地编写它(复制它),我不知道如何在我的YAML文件中对其建模(当对象作为请求主体的一部分作为有效负载时,我知道如何对其建模)。 这是我尝试建模的表单数据有效负载: 我查看了Swagger的文档:https://swagger.io/docs/spe ..
发布时间:2022-08-11 16:45:16 其他开发

Savagger编辑器如何指定请求正文(POST)中的哪些字段是必需的?

我正在尝试在联机Swagger编辑器中的User类上定义POST方法。 我希望能够在请求正文中指定多个字段,并且希望生成的文档反映只有2个字段是必需的,其他字段是可选的。 我必须做什么/更改才能做到这一点? 我尝试了使用";Required&Quot;关键字的各种变体(参见下图中的一个),但无法实现,它不会显示在生成的文档中(参见右下方带有红色注释的图片)。 以下是 ..
发布时间:2022-05-24 15:17:36 其他开发

如何在OAS3中记录计算的默认值

我正在更新我的API规范(OAS 3.0.0),并且无法理解如何正确地对“复杂”默认值建模。 一般情况下,参数的默认值为标量值(即offset字段的默认值为0)。但在我正在规范的API中,默认值实际上是根据其他提供的参数计算的。 例如,如果我们从示例文档中获取Pet model,并决定所有动物都需要标记,会怎么样。如果API的用户想要提供标记,那就太好了。如果不是,它将等于该名称。 一种 ..
发布时间:2022-05-24 14:48:02 其他开发

当我从开发的值更改ASPNETCORE_ENVIRONMENT的变量时,Swagger页面不起作用

我有一个基于.NET6的Web API。 此Web API在Azure应用程序服务上运行。Azure应用服务在Linux上运行。 我使用Open API(Swagger)进行测试和文档编制。 我创建了2个应用程序设置文件。(开发和阶段) 我将ASPNETCORE_ENVIRONMENT变量添加到Azure应用服务的配置中,如下所示。函数用于ASPNETCORE_环境的两个变量(开发和阶段) ..

这些OpenAPI 3路径是否有歧义?

这些OpenAPI 3路径是不明确的吗? /shops/{shopId}/pets/{petId} /shops/{shopId}/pets/_search 我想回答否但是,严格阅读规范,我无法决定,因为它们似乎不属于规范所做的3个陈述中的任何一个: 这两条路径都不是具体(规范中使用的术语) 路径似乎不符合具有相同层次结构但不同模板化名称的模板化路径条件(我不是很清楚):" ..
发布时间:2022-05-24 14:09:50 其他开发