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