设计和开发 API 涉及大量的重复和重写描述。开发者、组织或独立团队可能会在各种 API 设计中用到大量此类可重复组件,而不断重写它们会令人感到繁琐和沮丧。这就是 SwaggerHub 域可以提供帮助的地方。简而言之,域是可重用组件的集合。可以存储在域中的组件有:
- 定义 :这些是描述您的 API 输入和输出的模型
- 路径项:一组可以在不同路径中重用的预定义操作
- 参数:API 的任何输入
- 响应:调用 API 后的输出
SwaggerHub 上的域管理方式与 API 相同。用户可以创建域并进行版本控制,然后定义其中的组件。这些组件可以由用户或 API 上的协作者从其他 API 或域中引用。域还可以作为多个 API 的控制中心,对一个域的更改可以迅速传播到所有引用该域的 API,从而实现更快的 API 开发和协作。
创建和使用域
每个域都有一个所有者、一个名称和一个版本。可以通过点击右上角的“添加新域”来创建新域。
设置好域的名称和版本后,用户可以在域中添加所需的组件。组件添加完成后,域就可以发布了。这里有一个示例域,帮助您开始使用。一个已发布的域可以被其他域和 API 可靠地引用。引用您自己的域非常简单!只需开始引用,让 SwaggerHub 的新自动建议功能帮助您选择正确的域和组件。开始输入您希望引用的域对象的名称,即可弹出自动建议。以下是自动建议如何根据您输入的内容显示最可能的对象。
您也可以直接使用以下语法引用公共域或共享的私有域: $ref: 'https://api.swaggerhub.com/domains/{ownerId}/{domainName}/{domainVersion}#/{componentType}/{componentName}'
管理域
已创建的域可以进行编辑、升级到不同版本、推送到 Github 或删除。域可以是公共的或私有的。公共域可以被其他 SwaggerHub 用户搜索、查看、引用和分叉,而私有域只能由您和您添加的协作者查看和操作。用户可以在搜索栏中选择“搜索域”来搜索其他用户在 SwaggerHub 上发布的一些不错的公共域。
域让 API 设计师的生活变得轻松。在 SwaggerHub 上试试它们吧,如果您有任何其他问题,请随时浏览我们的功能文档或常见问题解答部分。