内部与外部API的差异
内部API用于提升企业内部效率，强调安全、控制和灵活性，但曝光度和资源有限；外部API可创收、提升品牌，促进创新与扩展，但有安全风险和维护成本。二者管理方式和文档侧重不同。
公共API/外部API
企业使用公共API来为公众提供一个标准化且安全的接口，以访问其数据来构建应用程序。它们向外部利益相关者（如外部开发者、第三方供应商和客户）开放，并通过互联网使用HTTP协议进行访问。外部API提供特定的功能或服务，例如访问数据或执行交易。
外部API的一些要点：
* 向公众开放 * 比内部API更常用于创建用户界面 * 创收或提升品牌知名度 * 收集使用指标以改进API * 管理后端组件之间的交互 * 有助于与其他业务应用程序集成
内部API
内部API旨在提高运营效率。公司使用内部API来访问其不向公众公开的敏感内部系统和数据。与公共API不同，内部API的功能非常具体，并非为通用用途而设计。内部API很少用于创建用户界面。
企业将内部API用作接口，供由不同组织开发团队构建的组件使用，这些团队负责不同的组件。此外，他们还使用内部API作为允许组件间通信的接口。企业还将API创建为独立的组件，以实现特定功能，而不仅仅是“连接器”。
关于内部API的一些要点：
- 不在互联网上公开
- 在公司或开发团队内部创建和使用
- 可能向内部利益相关者提供对敏感数据的访问
- 侧重于特定的功能，而非“通用用途”
- 用于连接微服务架构中的组件
- 处理连接后端服务，而非创建用户界面
公共API/外部API – 优点
收入
公共API有潜力通过向第三方应用开发者开放数据来产生收入。
品牌知名度
企业可以通过公开其API来提高品牌知名度，无论API是否产生收入。此外，由于API适合广大受众，其影响范围可以扩展到开发人员之外，触及业务利益相关者和平民开发者。
社区建设
公司可以围绕其公共API培养一个不断壮大的社区。社区可以建议新功能，并为每个版本提供持续的反馈循环。
创新
通过公开您的数据，第三方可以以API开发人员最初未曾预料到的方式进行创新。第三方开发者可以将您的产品与其他业务应用集成，从而丰富您的应用生态系统。
可扩展性
API 为第三方访问公司数据提供了标准接口。标准接口允许公司在无需投入大量资源支持新用户的情况下实现扩展。统一的接口也意味着公司无需创建难以维护的定制解决方案。
准备好将您的 API 文档提升到新水平了吗？立即预约 Baklib 的演示！
公共 API / 外部 API – 缺点
安全风险
如果公共 API 没有得到充分的监控和安全保障，就会带来安全风险。即使采取了必要的安全措施，也始终存在用户利用 API 漏洞获取数据的风险。因此，公司应建立透明的流程来报告安全漏洞并进行安全检查。
对第三方的依赖
使用 API 构建的应用程序的受欢迎程度决定了 API 是否成功。当更多客户使用该 API 时，其价值和采用率就会增加。
复杂性增加
内部 API 是根据公司内部需求定制的，而公共 API 必须迎合广大受众，并支持多种用例和第三方应用程序。
支持与维护
公共 API 需要持续的支持和维护，以确保其稳定性、安全性和可靠性。
法律与法规合规性
它们必须遵守内部 API 无需遵循的法律和法规合规要求。保持合规性增加了 API 维护的复杂性。
内部API的优势
增强安全性
与公共API不同，企业在防火墙后的内部网络中托管内部API。因此，您可以限制只有公司内部授权的用户以及公司使用的应用程序才能访问。
💛🧡🧡客户评价：有时实验中的页面编辑器会感觉有点笨重，有时对 HTML 的更改似乎没有生效或导致页面体验出乎意料。不过，Baklib非常棒的客服支持团队随时可以解决我遇到的任何问题。
更好的控制
内部API让企业能够控制组织内谁可以访问哪些功能和数据。
灵活性
您可以专注于创建满足公司特定需求的API。
降低成本
内部团队可以创建API来解决他们的问题，并且通过不采用第三方API来节省成本。
内部API的劣势
曝光度有限
由于不向公众公开API，企业无法利用机会创造收入、提高品牌知名度或收集有助于改进API的使用指标。
资源有限
私有API通常需要更多的资源来支持和增长，因为它们不产生收入。公司的盈利产品通常比它们更优先，这导致API得不到维护和更新。
不受支持的内部API会随着时间的推移而失效，因为内部开发人员不再信任其输出，并可能选择功能相同但维护得更好的第三方API。这就是为什么内部API应尽可能简单，以便于维护。
可见性低
导致资源不足的另一个因素是可见性不够，特别是对业务相关方而言。内部开发人员需要向业务相关方和管理者传达内部API的价值，以便他们能提供必要的资源来维护它。
有限的用例
它们通常连接着对非开发人员利益相关者价值较低的后端资源。然而，在业务用户的支持下，内部API可以发展，以支持组织中的其他类型的用户。
缺乏创新
未向公众公开的内部API可能永远无法通过允许第三方以新颖和创造性的方式使用它们来充分发挥其潜力。缺乏创新的内部API可能会促使开发人员采用可比较的公共API。
什么是API管理？
API管理是设计、发布、监控和保护应用程序编程接口（API）的过程，这些API由开发人员、客户和其他利益相关者用来访问公司的软件和数据。
直观的知识库软件，可轻松添加您的内容并将其与任何应用程序集成。试试 Baklib 吧！
为什么API管理至关重要？
API管理对于内部和公共API都至关重要。然而，在我们展示如何以不同方式管理它们之前，让我们回顾一下为什么API管理如此关键。
安全性
API管理有助于实施身份验证和访问控制、加密数据以及监控安全。这些因素保护敏感数据并防止未经授权的访问。
可靠性
API管理通过提供有关使用模式、用户行为和性能指标的实时数据的分析，确保API的可靠性。因此，公司可以识别潜在问题，如性能瓶颈和错误，并在它们成为重大问题之前加以解决。
可扩展性
开发者工具和文档使第三方开发者能轻松使用API。此外，它具备可扩展性，因为当配备适当资源后，API就能实现自助服务。
节省成本
提供标准化的API具有成本效益，因为您无需为每位客户维护定制的集成方案。
API管理最佳实践
API管理涉及多个关键步骤，有助于确保API的安全性、可靠性和可扩展性。以下是一些管理API的最佳实践。
有效设计API
您应该设计出可靠且可扩展的API。定义端点、数据格式和认证机制是有效API设计的一部分。
记录API
API使用者需要帮助他们理解API的资源，包括参考文档、概念文档、代码示例、教程和其他开发工具。
测试API
您必须对API进行严格测试，以确保其按预期运行。测试包括功能测试、性能测试和验收测试。
发布API
发布是将API暴露给目标用户（无论是内部还是外部）的过程。公共API通常通过API管理平台发布，该平台将API暴露给客户。像Baklib这样的平台为客户提供访问文档和开发者工具等资源的权限，帮助他们理解并体验API。
发现API
存在一种误解，认为可发现性仅对公共API至关重要。然而，API必须对内部和外部利益相关者都易于发现。遗憾的是，创建用于搜索和筛选API的用户界面需要资源，而内部API通常更需要这些资源。因此，企业应考虑内部API未来是否有可能变为“公共”，如果是，则应适当投资于其可发现性。
保护 API 安全
实现适当的身份验证和访问控制对于 API 的安全至关重要。对于公开 API，API 网关通过用户身份验证、传输中和静态数据加密以及监控安全威胁来管理 API 安全。
管理访问权限
您必须实施授权策略，以控制谁可以访问您的 API 以及分配给他们哪些权限。
监控 API
对于公开 API，您可以利用 API 管理平台的分析功能来收集有关 API 性能的实时使用数据。此类平台可以预先识别问题，例如错误、性能瓶颈和安全威胁。
收集分析数据
您应捕获并分析数据，以深入了解使用模式、用户行为和性能指标。这样，您就可以利用这些洞察来优化性能并改善开发者体验。
更新 API
为了与您的 API 用户建立信任，您应定期更新 API，向用户表明您的 API 维护良好并吸收了反馈。
管理策略：内部 API 与公开 API/外部 API
既然我们已经了解了 API 管理的基础知识，现在我们来讨论内部 API 与公开 API 的管理方式有何不同。
身份验证和访问控制
公开应用具有更严格的身份验证和访问控制。公开 API 需要集成 OAuth 2.0 等服务进行身份验证，并且在许多情况下，要求用户注册 API 密钥来标识其请求。
文档和开发者工具
公开 API 需要为开发者提供更多资源，例如详尽的文档和开发者工具。此外，公开 API 通常需要迎合非技术性的业务利益相关者，而私有 API 通常用于后端服务。
盈利模式
如果公共API被用于产生收入，就需要一个盈利模式，这要求额外的管理层。通常，收费基于API使用量、分层定价计划或从第三方应用程序产生的收入中抽取一部分。
性能与可扩展性
公共API必须具备高性能和可扩展性，以同时处理大量平台用户。相比之下，内部API的用户数量通常有限，因此它们承受的压力较小。
分析与监控
收集分析数据对于改进公共API至关重要，但这增加了另一层复杂性。内部API也能从分析中受益，但程度较低。内部API更具可预测性和可控性。
同时，请查看我们关于API策略的文章。
记录内部与公共/外部API
内部开发文档通常包含更多细节，因为它是针对内部开发团队的技能和知识而定制的。
外部文档的读者群体广泛。企业在编写公共开发文档时，会考虑用户不同的技术能力水平。公共开发文档中包含（而内部开发文档中通常不包含）的主题包括认证要求、速率限制、数据格式和错误代码。
公共开发文档提供了更多的安全考量，如用户认证和存储敏感数据。另一方面，内部API更安全，不需要为与公众交互而设计架构。因此，其重点更多地放在如何使用API来连接内部系统组件上。
企业通过开发者门户发布公开的开发文档，提供在线资源以帮助公众理解可用的API。而内部开发文档传统上使用诸如Swagger之类的工具发布，仅在公司内网可用。
公开与内部的开发文档在提供的细节程度、安全信息以及访问方式上有所不同。
同时，请查阅我们关于SwaggerHub替代方案的文章
总结
一个API是公开还是内部使用，取决于其受众和用途。每种类型都有其优缺点，企业在开发API时必须加以权衡。
公开API有潜力创造收入、提升品牌知名度、促进社区建设和创新，并提高可扩展性，但其代价是安全性挑战、复杂性增加以及持续的支持和维护工作。
私有API则能提供更强的安全性、更高的运营效率、更精细的访问控制和更大的灵活性，但其代价是曝光度有限、资源可能减少、可见性受限，并且对更广泛受众的实用性较低。
最终，公开API拥有一个关键优势：能够通过与公众的反馈循环来不断改进。
要克服内部API的"缺点"，公司需要优先考虑这些功能的维护工作，以及创收产品是如何依赖它们的。内部API需要得到倡导，证明其值得投入资源，以获得业务利益相关者和管理者的支持。公司在分配资源时，应考虑该API未来是否有可能转变为公开API。
