我们之前说过，现在还要再说一遍：可见的 API 会被重用，而不是重新发明。确保开发人员可以轻松地使用 API 至关重要。
为了实现这一点，我们需要为他们提供清晰的文档和有用的资源。 这就是 SwaggerHub Portal 的用武之地，它简化了流程，使开发人员更容易完成工作。
为什么选择门户？
SwaggerHub Portal API 使您能够轻松地将 API 产品化。您可以创建一个带有入职指南、资源和文档的品牌落地页，帮助消费者理解您的 API 并将其集成到他们的应用程序中。
现在，您可以使用我们自己的SmartBear 门户来自动化设置过程并使您的门户上线。借助 SwaggerHub Portal API，您可以为开发人员提供一流的开发者体验 (DX)。 他们将受益于用户友好的界面和交互式文档，从而加速 API 的采用。
入门指南
在深入了解具体细节之前，这里有一些入门的先决条件：
- SwaggerHub 帐户：您需要企业许可证Swagger Hub 帐户。
- 用户角色：您需要在 SwaggerHub 组织中拥有设计者或所有者角色才能调用 API。
- 启用 SwaggerHub 门户：必须为您的组织启用 Swagger Hub 门户。
满足这些先决条件后，您就可以使用SwaggerHub Portal API 来自动化配置开发者门户的过程了。
身份验证
要与门户 API 交互，您需要来自 SwaggerHub 的 API 密钥。 此 API 密钥应包含在“Authorization”标头中，格式为“Bearer [your_api_key]”，用于您发出的每个 API 请求。
配置您的开发者门户
第一步之一是自定义开发者门户的外观。 虽然尚无法通过 API 上传品牌图片，但您可以设置强调色、字体和落地页描述。
- 获取门户标识符：要管理您的门户设置，您需要通过调用“portals”API 资源来获取门户实例的标识符。
- 设置门户设置：利用获得的门户 ID，通过 PATCH 请求更新您的门户设置。 您可以调整强调色、字体和落地页描述。
添加产品
产品是开发者门户的重要组成部分。 您可以通过 Swagger Hub Portal API 管理产品内容，包括 API 定义和文档。
- 创建产品：向“products”端点发送 POST 请求以创建新产品。 包括门户 ID、产品名称、描述、slug 和其他相关详细信息。
- 添加徽标：轻松添加您的公司徽标，以增加整个门户的品牌效应。
填充产品内容
创建产品后，就可以用内容填充它了，包括 API 定义和文档。
- 创建部分：部分充当内容的占位符。 向“sections”端点发送 POST 请求，指定产品的部分。
- 添加 API：向部分的“目录”发送 POST 请求以添加 API 参考。 包括标题、slug 和内容（通常是对 OpenAPI 定义的引用）。
- 添加文档：要提供全面的文档，请在您的技术 API 参考旁边添加 Markdown 文档。 向该部分发送 POST 请求，但这次使用 Markdown 内容。
- 发布内容：最后，发布产品内容使其可以在您的门户上访问。 发送请求以更新产品的已发布内容。
下一步是什么
门户 API 使您能够简化开发者门户的配置和管理。 无论您是添加产品、更新内容还是自定义门户的外观，这些 API 都提供了一种强大的方式来自动化流程并增强开发者体验。
通过门户，您可以将空的开发者门户转变为用户友好的 API 文档和资源中心。 这种自助服务方法可以增强您的开发团队的能力并加速 API 的采用。
立即将门户 API 集成到您的工作流程中，以增强您的开发者门户，并为开发人员提供他们取得成功所需的工具。 有关详细的分步设置指南，请观看SwaggerHub 门户 API 入门。
免费试用！