api - OpenAPI 或 swagger.json 自动发现-6ren

api - OpenAPI 或 swagger.json 自动发现

转载作者：行者123 更新时间：2023-12-04 23:39:42

25

4

是否有任何关于 URL 的规范或约定应该放置 swagger.json (或任何约定的名称)以便可以自动发现我网站的公共(public) API？

最佳答案

2017 年 4 月 19 日更新:我之前给出的 OpenAPI Wiki 答案是 "for a very very very old version of the spec" .同一来源指出，对于 2.0，标准是 swagger.json。，对于 3.0，它更改为 openapi.json .

原答案:

The OpenAPI Wiki recommends using an /api-docs endpoint, at least for server APIs. I've seen several sites in the wild that use that, and it's our shop standard.

希望有帮助。

关于api - OpenAPI 或 swagger.json 自动发现，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/41660658/

25

4

0

文章推荐： Emacs Helm : what actions can I do in a helm buffer?

文章推荐： android - 如何检测 Android Go？

文章推荐： java - Activity 没有设置 NavController

文章推荐： apache-fop - 将 FopFactoryBuilder baseURI 设置为 jar 类路径

openapi - OpenAPI 中的服务版本控制
我们即将为我的客户端实现一个服务 API，它由许多服务组成，比如说 ServiceA、ServiceB 和 ServiceC。每个服务都可以随着时间的推移(独立地)引入新版本，而旧版本仍然存在。所以我
openapi - 如何在 OpenAPI 中至少需要两个参数之一？
我正在使用 OpenAPI 3 并有两个查询参数，其中至少一个是必需的，但哪个无关紧要。即，作为sudocode: if parameter_1 OR parameter_2: do stu
openapi - Quarkus Openapi 扩展 : Get the generated openapi yml file at build time
为了生成客户端库，我会在构建时获取 Quarkus 生成的 openapi yml 文件。目前我发现获取它的唯一方法是运行服务器并从/q/openapi 端点获取它，但在这个过程中必须运行服务器只是
openapi - 是否可以在 OpenAPI 3 中引用单个路径和方法？
假设我有一个描述 API Foo 的 OpenAPI 3 文档，如下所示: openapi: 3.0.0 info: version: '1' title: Foo paths: /foo:
openapi - OpenAPI 中正则表达式 "pattern"的共同点是什么？
我正在使用 FastAPI，它允许 pattern=re.compile("(?P[42a-z]+)...") . https://editor.swagger.io/显示此模式的错误。我的猜测是
springdoc-openapi 在没有服务器的情况下生成 openapi yaml
我有一个 Spring boot Gradle 项目，我想获取它的 OpenAPI 规范 YAML 文件。据我了解官方swagger-core不支持 Spring boot 项目，所以我找到了 sp
openapi - 如何在 openapi v3 中指定端点的授权是可选的？
我正在尝试记录包含各种身份验证是可选的端点的现有 API。也就是说，如果用户获得授权，则返回的数据比未授权时返回的数据多。无法在 OAspec v3 中明确找到。是否有编码技巧来定义这种情况？我目
openapi - 如何使用 $ref 从另一个 OpenAPI 文件引用路径？
Here它说我可以引用另一个文件中单个路径的定义，但该示例似乎引用了整个文件，而不是 paths 下的单个路径定义。目的。如何在另一个文件的 paths 中分配单个路径目的？例如，我有 Anothe
openapi - 如何在 OpenAPI 3.0 中定义带有两个可选参数的路径？
我在 SwaggerHub 注册并使用 OpenAPI 3.0 创建了一个新 API。在我的 API 中，/tasks path 有 2 个非必需参数，但我无法将它们设置为不需要 - 编辑器显示“不允
openapi - 服务器属性在 OpenAPI 3.0 中有什么意义？
在 OpenAPI 3.0 Specification ，根OpenAPI Object有 servers属性是 Server Objects 的数组.和 Path Item Object还允许可选的
openapi - 有没有办法在 OpenAPI 3.0 中描述两种不同的响应类型？
我想要做的是指定有时对 API 调用的响应可能是 PDF 文档，有时是 JSON。我想以 OpenAPI 3.0 格式执行此操作。对于 PDF，响应将如下所示: responses:
openapi - 如何在 OpenAPI YAML 中为 MP3 文件编写响应？
我正在编写一个返回 MP3 文件的 API YAML。我不熟悉多媒体响应。在通过 Google 时，我发现我可以使用 audio/mp3 内容类型。但我找不到任何例子来说明如何去做。我应该如何处理这种
openapi - 搜索 JavaScript 库以根据 OpenAPI 模式验证 JSON
我正在寻找一个 JS 库(最好能在浏览器中使用)来: 根据 OpenAPI 3.0 架构(YAML 或 JSON)检查特定的 JSON 负载(通常是来自 API 的响应) 使用从 OpenAPI 3.
openapi - 是否可以覆盖 OpenAPI 3 中引用参数的 "required"属性？
我正在构建一个简单的 OpenAPI 3 YAML 规范，如下所示: paths: /query: get: parameters: - $ref: '#/co
openapi - 为什么 OpenAPI 不将 '$ref' 定义为允许的属性？
与 draft-07 相比，它定义了: { "type": ["object", "boolean"], "properties": { ... "$r
openapi - 如何在 OpenAPI 3.0 的组件/示例部分正确定义示例？
我正在尝试使用 OpenAPI 3、YAML 来构建 API 定义。我一直在使用文档 https://swagger.io/docs/specification/adding-examples/关于
openapi-generator - 无法从 openapi-generator mustache 模板引用供应商扩展
我有一个 Open API 3 规范的 yaml 文件，它有一些 x- 前缀的属性。我正在尝试使用 openapi-generator-cli 生成一个 Angular Typescript SDK。
java - Helidon MP OpenAPI 未生成更新的 openapi 端点响应
我目前正在按照 Oracle 本身的指南和教程构建基于 Helidon Microprofile 的微服务，但在使用注释时遇到了与“自动 OpenAPI 规范生成器”相关的问题。我的 POM 包含
java - Swagger/Openapi 和 openapi-generator 我们在哪里添加业务逻辑代码？
我必须从头开始创建一个rest api。通过手动完成大部分工作，我已经对 Jersey 有了一些经验。我想现在就做，因为这个项目是新的。因此，我目前正在尝试每次尝试 openapi 3.0 在线编辑
openapi - 如何在 OpenAPI 3.0 的架构中使用 $ref？
我想将以下 JSON 表示为 schema在 OpenAPI 3.0 API 定义中: { get-question: { question-id:string } } 到目前为止，我已经写了

首页

博学

6Ren·AI

商城

api - OpenAPI 或 swagger.json 自动发现