SwaggerHub 域加速您的 API 开发

  2016 年 3 月 2 日

API 的设计和开发涉及大量的重复和重写描述。一个开发者、组织或独立的团队会在各种 API 设计中使用大量此类可重复的组件,而不断地重写它们可能会很繁琐和令人沮丧。 这就是 SwaggerHub 域可以提供帮助的地方。简而言之,域是可重用组件的集合。可以存储在域中的组件有

  • 定义:这些是描述 API 输入和输出的模型
  • 路径项:一组可在路径中重复使用的预定义操作
  • 参数:API 的任何输入
  • 响应:发出 API 调用时的输出

SwaggerHub 上的域的管理方式与 API 相同。用户可以创建域并对其进行版本控制,然后在其中定义组件。 组件可以被用户或 API 上的协作者从其他 API 或域中引用。 域还可以充当多个 API 的控制中心,对域中的一项更改可以快速传输到引用该域的所有 API,从而加快 API 开发和协作。

创建和使用域

每个域都有所有者、名称和版本。可以通过单击右上角的“添加新域”来创建新域。 添加域 在设置好域的合适名称和版本后,用户可以在域内添加所需的组件。 放入组件后,即可发布域。这是一个示例域来帮助您入门。已发布的域可以被其他域和 API 可靠地引用。引用您自己的域很容易! 只需启动引用,让 SwaggerHub 的新自动建议功能帮助您选择正确的域和组件即可。开始输入您要引用的域对象的名称,以显示自动建议。 这是自动建议如何根据您键入的内容显示最有可能的对象的方式。 SwaggerHub 域自动填充 您还可以使用以下语法直接引用公共或共享的私有域: $ref: 'https://api.swaggerhub.com/domains/{ownerId}/{domainName}/{domainVersion}#/{componentType}/{componentName}'

管理域

创建的域可以编辑、升级到不同版本、推送到 Github 或删除。域可以是公共的或私有的。 公共域可以被其他 Swaggerhub 用户搜索、查看、引用和分叉,而私有域只能由您和您添加的协作者查看和使用。 用户可以在搜索栏中选择“搜索域”以搜索其他用户在 Swaggerhub 上发布的一些简洁的公共域。 搜索 API 域使 API 设计人员的生活变得轻松。 在 SwaggerHub 上试用它们,如果您有任何其他问题,请随时浏览我们的功能文档常见问题解答部分