SwaggerHub 的创建旨在改变团队使用 Swagger (OpenAPI) 进行 API 开发的协作方式。除了整合开源 Swagger 工具的核心功能外,SwaggerHub 还提供了一个中心平台,供您托管和管理所有现有 Swagger 定义,并与您的整个团队协作进行 API 的设计和文档化。自平台发布以来,我们从 SwaggerHub 用户那里听到的最常请求的功能之一是更好地组织不同内部团队正在处理的 API 的能力。对于这些团队而言,SwaggerHub 已成为托管和发现所有现有 Swagger 定义的中心存储库。随着这些组织不断扩展其 API 开发规模,更好地在各个团队之间组织其 API 定义的需求变得越来越明确。今天,我们很高兴地宣布推出项目功能,它是在 SwaggerHub 中组织团队 API 的更好方式。
项目如何运作
截至目前,在 SwaggerHub 中组织 API 的最佳方式是使用组织(Organizations)。组织允许您将所有团队成员和共享的 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 控制面板顶部的聊天图标与团队成员交谈。