Open API 生成器的身份验证

Dan*_*ani 6 openapi openapi-generator

如果已经回答了这个问题,我深表歉意,但我找不到明确的答案。

目前的生成器支持认证吗?

我需要生成一个具有两种潜在身份验证方式的客户端:

  1. 通过 API key,这意味着必需的api_token参数。
  2. 通过 OAuth 2 身份验证代码流。

如果有,我该如何使用它?

如果没有,您认为在生成客户端后添加身份验证的最佳方法是什么?

jac*_*arm 1

鉴于OpenAPI 生成器可以与公开 OpenAPI 文档的任何服务器进行交互,因此首先需要一个利用安全方案术语进行身份验证和授权的 OpenAPI 文档。OpenAPI 3.0(和 2.0)允许您描述两种所需的身份验证方法。

一旦创建了.yaml或格式的 OpenAPI 文档,我相信入门指南.json说明描述了根据您为身份验证流程创建的 OpenAPI 文档生成用于身份验证的服务器存根所需的命令。

例如,如果您的 OpenAPI 文档恰好是Swagger Petstore 示例,您将这样“生成”:

npx openapi-generator 生成 -i petstore.yaml -g ruby​​ -o /tmp/test/

  • OP 寻求有关 OAuth 2 *在客户端*(而不是在服务器)实施的帮助。 (3认同)