173得票7回答
如何在Swagger规范中使用'Authorization: Bearer <token>'?

我试图传达的是,身份验证/安全方案需要设置一个头部,如下所示: Authorization: Bearer &lt;token&gt; 这是我根据swagger文档所得出的内容: securityDefinitions: APIKey: type: apiKey n...

165得票1回答
如何在OpenAPI(Swagger)中定义一个可为字符串或null的属性?

我有一个JSON模式文件,其中一个属性被定义为string或null: "type":["string", "null"] 转换为YAML格式(用于OpenAPI / Swagger),它变成: type: - 'null' - string 但Swagger编辑器显示错误...

147得票5回答
在OpenAPI / Swagger文件中,正确声明日期的方式是什么?

在swagger文件对象中,声明日期的正确方式是什么?我认为应该是: startDate: type: string description: Start date example: "2017-01-01" format: date 但是我看到很多类...

119得票13回答
Swagger/OpenAPI模拟服务器

我有一个Swagger文件中的API参考文档,我想创建一个非常简单的模拟服务器,这样当我调用例如: mymockurl.com/users 时,它会返回预定义的JSON(无需连接到数据库)。 最简单的方法是什么?我不是后端开发人员。

114得票3回答
如何基于现有的Postman集合生成Swagger文档?

我正在开发一个REST API。在开发过程中,我使用了Postman(Chrome扩展程序)来使用和记录我的API。这是一个很棒的工具,我把大部分的API端点都放在了里面。 然而,随着我们接近发布,我想用Swagger来记录这个API,我该如何做呢?有没有办法可以根据Postman导出的内容生...

103得票3回答
如何在JSON Schema和Open API(OAS)中定义UUID属性

当使用JSON Schema和Open API specification (OAS)来记录REST API时,如何定义UUID属性?

101得票2回答
Swagger/OpenAPI - 使用 $ref 传递可重用的定义参数

假设我有一个参数叫做limit。这个参数在许多地方都被使用,如果我需要更新它,那么要到处修改它就很麻烦:parameters: - name: limit in: query description: Limits the number of returned ...

97得票3回答
如何在OpenAPI/Swagger中指定字段是可选的还是必需的?

如何在OpenAPI / Swagger中定义字段是可选还是必需的,以及默认值是什么? 如何在OpenAPI / Swagger中定义字段是可选还是必需的,以及默认值是什么?

83得票2回答
如何在OpenAPI(Swagger)2.0中将字段标记为已弃用?

我有以下模式定义:swagger: '2.0' ... definitions: Service: type: object properties: serviceId: type: string description: Dev...

83得票4回答
如何在OpenAPI(Swagger)中定义枚举?

有人知道如何在OpenAPI 2.0定义中定义可能的enum值,以便它们会显示在Swagger UI的模型选项卡中吗?这里的示例有一个status属性的枚举选项。 如何在OpenAPI 2.0中定义这样的枚举?