Change API Settings

您可以修改现有 API 的配置，以更新 API 的核心细节、规范来源、标签和安全设置。

如果您使用的是网格视图，请单击三点菜单以打开操作项，然后单击编辑按钮（铅笔图标）以打开 API 详细信息表单。

如果您使用的是列表视图，请转到操作列并单击编辑按钮（铅笔图标）以打开 API 详细信息表单。

单击编辑按钮将打开编辑 API 详细信息表单。根据需要填写您的更改。

• Backend Name: （必填字段）API 的用户友好显示名称（例如，PetstoreV3）。

• Backend System Name: （自动填充字段）API 的唯一内部标识符（例如，petstorev3）。此名称通常用于系统引用，并可能有字符限制。

• Version: （必填字段）您的 API 的版本号（例如，v1.0.0）。建议遵循语义版本控制实践。

• Domain: （必填字段）您的 API 所托管的基础域（例如，https://petstore3.swagger.io/api/v3）。

• BasePath: （必填字段）附加到域以形成所有端点的完整基础 URL 的子路径（例如，/）。

• Open API Specification: （必填字段）提供 API 的定义文档，该文档描述其所有端点和操作。您必须以三种方式之一指定此定义的来源：

  • From URL: 提供指向 OpenAPI 定义文件的直接网页链接（例如，.json 或 .yaml 文件）。

• Paste JSON: 将OpenAPI JSON定义的原始内容直接粘贴到文本字段中。

• Upload File: 从本地计算机上传OpenAPI定义文件。

• Description: （必填字段）提供API目的和功能的详细可读描述的文本字段。此信息显示在API概述屏幕上，帮助其他用户理解如何使用API。

• Authentication Type: （必填字段）选择客户端访问API所需的安全方法。

  • Basic: 需要用户名和密码进行身份验证。
  • Bearer: 需要在Authorization头中提供一个承载令牌（例如JWT）。
  • API Key: 需要发送特定的API密钥，通常在请求头或查询参数中。
  • None: 该API是公开的，不需要身份验证凭据即可访问。

• Label: 此部分允许您管理标签，这些标签是用于组织、过滤或为API添加自定义元数据的键值对。

  • 添加标签：单击加号（+）图标以添加标签的新行。
  • 键/值：每个标签都需要一个键（标识符，例如环境）和一个值（数据，例如演示）。如错误消息所示，一旦添加标签行，两个字段都是必需的。
  • 删除标签：单击垃圾桶图标以删除相应的标签行。 在验证您输入的信息后，点击 Save 按钮以将新配置应用于 API。如果您希望放弃在此屏幕上所做的所有更改，请点击 Cancel 按钮以关闭表单。