导入 OpenAPI / Swagger
6 分
为什么使用 OpenAPI 导入？
如果您的产品是为开发人员构建的，或者您的产品具有 API，那么您需要优秀的产品文档——否则，您将无法真正触达开发人员。
一旦您导入 OpenAPI 文件，Archbee 将读取并将其转换为精美的 UI，并准备好用于：
- 公开共享 （在自定义域名上）
- 内部共享，与您的同事和团队一起使用
导入后，您可以同步、更新并测试您的 OpenAPI。更多详情请参见下方章节。
规则和默认设置
导入的 OpenAPI 文件无法在 Archbee 中手动修改。
要更新和维护您的 OpenAPI，请查看我们的同步选项
支持的 OpenAPI 版本：
Archbee 当前支持以下 OpenAPI 版本导入：
- 版本 2.0 和 2.0.XX
- 版本 3.0 和 3.0.XX
- 版本 3.1 和 3.1.XX
支持的 Auth 方法
Archbee 当前支持以下 Auth 方法：
- API Keys
如果您导入的 OpenAPI 文件使用其他 Auth 方法，它们仍会被正确导入，但 Auth 方法将被忽略。
这意味着您仍将获得完整的 Archbee OpenAPI 体验，除了当您的 endpoint 需要上方列表之外的 Auth 方法时，将无法使用 Try It! 功能。
其他
- 如果您在 OpenAPI 中定义了“默认”参数并为其提供了值，代码示例和参数框将自动预填充该值。 这使您的用户或客户能够轻松测试 API，使用试一试！而无需更新所有必填参数。
- 如果您在 OpenAPI 中定义了“示例”参数，则示例值将显示在左侧、API 参数下方。 这可帮助用户识别该参数所需的输入类型。
它是如何工作的？
发布 或 分享它 给您的同事或客户！
将其发布到 Preview 或自定义域名，使其可供您的同事、团队或用户访问。
如果您希望保护内容并仅分享给特定对象，请查看我们针对已发布门户的 公共访问控制 选项。
以下是其工作方式的视频演示
Have a question?
Our super-smart AI, knowledgeable support team and an awesome community will get you an answer in a flash.
To ask a question or participate in discussions, you'll need to authenticate first.