openapi相关内容
我在Program.Main()中使用.ConfigureOpenApi()向Azure Functions应用程序(V3)添加了OpenApi支持。我对特定函数使用函数修饰,但如何控制~/api/swagger/ui上显示的通用API名称、版本等? 以下是我的Program.Main()代码: public static void Main() {
..
我希望有一种方法来声明对每个终结点都相同的一些响应;例如,如果您没有正确的令牌,每个终结点将输出401,如果您的路径开头没有有效的id,则可能有另一组终结点都将输出id。 因此,对于几乎每种方法,我发现自己复制粘贴的内容如下: * @OAResponse(response=401, description="If no token..."), * @OAResponse(respons
..
在我的rest API中,我想使用散列图Map>,其中Foo和Bar是用户定义的类。如何在OpenAPI(Swagger)中描述这样的地图? 推荐答案 OpenAPI(Swagger)仅支持字符串键为: 的映射 { "en": "Hello", "fr": "Bonjour" ^^ key is a string } 不能用Ma
..
我要为响应是词典词典的架构建模: { 'id1': { 'type': 'type1', 'active': true, }, 'id2': { 'type': 'type2', 'active': false, }, ... ... } 我已定义: components: schemas: accountD
..
我正在使用带有OpenApi 3.0.2规范的swagger-UI。 我设置了一个包含多部分/表单数据内容的questBody。 当我从swagger-ui执行请求时,一切正常,但是... 如果我添加一个数组类型的参数,它将在cURL调用中转换为这样的方式: -F "tags=my,tag" 我需要分解数组 -F 'tags[]=my' -F 'tags[]=tag' 我查看
..
我使用的是swagger 2.0,我有一个终结点,它使用表单数据作为请求的有效负载,我在几个地方使用相同的表单数据主体请求,我不想一次又一次地编写它(复制它),我不知道如何在我的YAML文件中对其建模(当对象作为请求主体的一部分作为有效负载时,我知道如何对其建模)。 这是我尝试建模的表单数据有效负载: 我查看了Swagger的文档:https://swagger.io/docs/spe
..
我当前在我的NestJS项目中使用Swagger,并且我启用了浏览器: 在main.js const options = new DocumentBuilder() .setTitle('My App') .setSchemes('https') .setDescription('My App API documentation') .setVersio
..
我使用的是Openapi 3.0.2版。 我有以下规范来描述我的响应: responses: '201': description: Created '400': description: Bad request content: application/json:
..
我在SwaggerHub上托管了以下OpenAPI定义: https://app.swaggerhub.com/apis/MyFirstAPI/1.0.1-oas3 openapi: 3.0.0 servers: - url: http://api.myfirstapi.com/ info: version: 1.0.1-oas3 title: Equ API paths:
..
我尝试严格遵循[本教程](https://cloud.google.com/community/tutorials/exposing-aspnet-webapi-using-dotnetcore-with-cloud-endpoints),但在尝试gcloud endpoints services deploy openapi.yaml时遇到以下错误: 错误:(gcloud.endpoint
..
我正在尝试在联机Swagger编辑器中的User类上定义POST方法。 我希望能够在请求正文中指定多个字段,并且希望生成的文档反映只有2个字段是必需的,其他字段是可选的。 我必须做什么/更改才能做到这一点? 我尝试了使用";Required&Quot;关键字的各种变体(参见下图中的一个),但无法实现,它不会显示在生成的文档中(参见右下方带有红色注释的图片)。 以下是
..
我有一个通过Terraform部署的AWS API网关(REST API): locals { api = templatefile("${path.module}/backend-api/api.json", { service-user-management = aws_lambda_function.user-management.invoke_arn }) }
..
我正在努力将路径参数从我的网关传递到实际终结点。 以下是我的Open API YAML: swagger: '2.0' info: description: | Blah blah version: 0.0.1 title: SSAuth contact: email: blah@gmail.com schemes: - https produces
..
我正在更新我的API规范(OAS 3.0.0),并且无法理解如何正确地对“复杂”默认值建模。 一般情况下,参数的默认值为标量值(即offset字段的默认值为0)。但在我正在规范的API中,默认值实际上是根据其他提供的参数计算的。 例如,如果我们从示例文档中获取Pet model,并决定所有动物都需要标记,会怎么样。如果API的用户想要提供标记,那就太好了。如果不是,它将等于该名称。 一种
..
我有多个路径需要ID号。有些路径需要多个ID。 我知道在构建路径时可以引用参数。 paths: /path1/{path1ID} parameters: - $ref: '#/components/parameters/path1ID_param' components: parameters: path1ID_param: name:
..
我有一个基于.NET6的Web API。 此Web API在Azure应用程序服务上运行。Azure应用服务在Linux上运行。 我使用Open API(Swagger)进行测试和文档编制。 我创建了2个应用程序设置文件。(开发和阶段) 我将ASPNETCORE_ENVIRONMENT变量添加到Azure应用服务的配置中,如下所示。函数用于ASPNETCORE_环境的两个变量(开发和阶段)
..
我想定义这个 "locationPoly": [ [-87.63466, 24.50182], [-80.03074, 24.50182], [-80.03074, 31.00107], [-87.63466, 31.00107], [-87.63466, 24.50182]
..
接口格式:GET /resource?param=value1¶m=value2¶m=value3 在Open Api 2.0中,我们可以这样指定: parameters: - in: query name: color type: array collectionFormat: multi items:
..
这些OpenAPI 3路径是不明确的吗? /shops/{shopId}/pets/{petId} /shops/{shopId}/pets/_search 我想回答否但是,严格阅读规范,我无法决定,因为它们似乎不属于规范所做的3个陈述中的任何一个: 这两条路径都不是具体(规范中使用的术语) 路径似乎不符合具有相同层次结构但不同模板化名称的模板化路径条件(我不是很清楚):"
..
我正在尝试在Visual Studio 2019中生成OpenApi服务引用。.NET 5.0。 右键单击项目&>添加&>连接的服务&>+服务引用 我正在使用NetDocs接口";https://api.vault.netvoyage.com/v2/swagger/docs/v2";. 结果:我得到了生成的C#客户端代码,但它复制了类型,错误如下。 Seve
..