隆重推出项目:在 SwaggerHub 中更好地组织 API 的方法

  2017 年 7 月 19 日

SwaggerHub 的创建旨在改变团队使用 Swagger (OpenAPI) 进行 API 开发的协作方式。除了整合开源 Swagger 工具的核心功能外,SwaggerHub 还提供一个中心平台,用于托管和管理所有现有的 Swagger 定义,并与整个团队协作进行 API 的设计和文档编写。自平台发布以来,我们从 SwaggerHub 用户那里听到的最常见的要求之一是 更好地组织不同内部团队正在开发的 API。对于这些团队,SwaggerHub 已成为托管和发现所有现有 Swagger 定义的中心存储库。随着这些组织不断扩展其 API 开发,越来越需要更好地组织不同团队的 API 定义。今天,我们很高兴地宣布推出项目,这是一种在 SwaggerHub 中更好地组织团队 API 的方法。

项目的工作原理

直到今天,在 SwaggerHub 中组织 API 的最佳方式是使用组织。组织允许您将所有团队成员和共享 API 分组在一个帐户下。组织的拥有者可以轻松地邀请团队成员加入组织,并可以管理每个协作者在 API 上工作的访问级别。但组织到目前为止的一个缺点是,每个成员都可以完全访问每个 API 定义,这使得管理团队正在开发的越来越多的 API 变得有些复杂。项目解决了这个问题——允许组织所有者创建名为项目的特殊文件夹,其中可以包含组织中选定数量的 API 或域(可跨多个 API 使用的可重用组件,用于标准化 API 设计),并将这些项目分配给其组织内的不同成员或团队。

项目如何帮助改进您的 Swagger 工作流程

我们看到 API 团队从开源 Swagger 工具或商业第三方 API 开发工具切换到 SwaggerHub 的最大原因之一是,要跟踪组织内不同团队在任何给定时间正在进行的不同的 API 项目变得太困难。API 开发是高度迭代的,从设计到部署需要您的软件开发团队中利益相关者的投入。项目提供了一种全新的方式来组织您的 Swagger 工作流程,并更好地管理参与帮助您使用 Swagger 构建世界一流 API 的人员。

如何在 SwaggerHub 中设置您的第一个项目

要创建项目,您需要成为组织的所有者。请按照以下步骤操作

1. 选择“新建”>“创建新项目”

2. 为您的项目命名

在接下来的屏幕上,指定项目所属的组织,并输入项目名称和任意描述(最多 40 个字符)。

3. 选择 API 和域

创建项目后,您可以向其添加 API 和域。您可以现在执行此操作,也可以稍后执行。要添加 API 和域,请在搜索框中单击,然后从下拉列表中选择一个 API 或域: 要更快地找到您的 API 或域,请在搜索框中输入其名称的任何部分。SwaggerHub 将动态筛选下拉列表。您可以根据需要添加任意数量的 API 和域。如果您在列表中看不到 API 或域,则很可能您的组织不拥有它。在这种情况下,您可以跳过此步骤,并在将 API(或域)的所有权转移到组织后,稍后将其添加到项目中。

4. 邀请成员

在此步骤中,您可以将用户添加到您的项目。您可以现在执行此操作,也可以稍后执行。要立即邀请用户,请在搜索框中单击,然后从下拉列表中选择所需的用户: 请注意,该列表仅显示您组织的成员。如果您在列表中看不到所需的用户,则必须首先将该用户添加到您的组织。

5. 完成项目配置

将 API 和域添加到项目并邀请用户后,在“邀请成员”页面上单击“保存”。这将保存您对 API 和用户列表所做的更改。在此处阅读 SwaggerHub 项目的完整文档。

开始使用项目组织您的 API 开发

项目旨在适应 API 团队的多种不同用例,这些团队需要维护和迭代大量 API。无论您是否有需要管理特定 API 项目的不同内部团队,还是需要更好地组织您的微服务架构中服务的不同 Swagger 定义,SwaggerHub 都可以提供帮助。立即登录以在 SwaggerHub 中启动您的第一个项目。请务必告知我们您对新功能的看法。向我们发送电子邮件[email protected],或单击 SwaggerHub 仪表板顶部的聊天图标与团队成员聊天。