什么是开发者门户？最佳实践及示例

原文链接：https://document360.com/blog/api-developer-portal-examples

开发者门户是什么？

DevPortal 奖的主要赞助商 Provonix 对开发者门户的定义如下：

“开发者门户（通常缩写为 DevPortal）是一组 API、SDK 或其他交互式数字工具与其各种利益相关者之间的接口。”

更直白地说，开发者门户是为公司提供的所有服务接口和解决方案的网站。它们是许多利益相关者的资源，而不仅仅是开发者的资源。

普通官网和开发者门户之间的一个主要区别是，普通网站是静态的内容，而开发者门户包含不断更新的动态内容。

与 wiki 不同，开发者门户是对外的，同时也作为内部利益相关者的资源。由于维基是内部的，所以当优先级从文档转移时，它们往往会被忽视并逐渐过时。由于开发者门户是对外的，因此与内部维基相比，其维护的优先级通常更高。

调查强调了高质量开发者文档的重要性。SmartBear 发布的《2019 年 API 状况报告》中的一项调查将**“准确详细的文档”**列为 API 的三大特点之一。开发者门户是 SaaS 公司共享文档的主要方式。

开发者门户和营销网站之间的关系也较为模糊。有时，一家企业会拥有一个链接跳转到其开发者门户的营销网站。而像只提供 SaaS 服务的公司等其他公司则会有开发者门户，但却没有专门的营销网站。

开发者门户的意义是什么

那么为什么公司应该投入时间和金钱来加强其开发者门户呢？一个好的开发者门户能够传递平台及其服务的价值。它描述了它们如何解决特定的业务挑战，而不是使用夸张的营销/广告。

虽然 API 文档经常与开发者门户相关联，但开发者门户不仅仅是开发人员访问其 API 参考文档的地方。开发者门户应该允许所有业务利益相关者（技术或非技术）了解和体验平台。

在下一节中，我们将探讨这些特性。

一个好的开发者门户的特点

统一解决方案

虽然 API 文档是开发者门户的一个重要方面，但它并不是全部。理想情况下，开发者门户应该作为公司产品和服务所有接口的中央资源。它们可能不仅仅局限于 API/服务。其他接口还包括图形用户界面（GUI）、无代码界面以及像面向没有访问开发者资源用户的小组件这样的低代码界面。

虽然 REST API 规范是开发者门户的重点，但也可以记录其他类型的 API，如物联网（IoT）API、语音助手 API、GraphQL API 或原生库 API。通常公司会有一系列服务，而不仅仅是一个 REST API。你可能会在开发者门户上看到数十种不同类型的 API 文档。除了 API 之外，开发者门户上提供的其他技术解决方案还包括客户端库或 SDK。有时，开发者门户还可以展示开发者构建的解决方案。

明确的商业模式

用户应该能够理解平台所在的行业及其提供的服务的广泛概述。解决方案应该根据它们解决的特定业务挑战进行分类。用户应该能够在心理上绘制出所有提供的解决方案以及它们如何在统一平台上协同工作的地图。

服务如何在更广泛的上下文中相互关联，可以通过文本、视觉图形或开发者门户本身的结构来传达。

明码标价

客户应该尽早了解平台的定价模式。定价结构应该传达它是如何解决特定问题的以及定价计划之间的差异。

开发者门户应该回答以下问题：

• API 产品