Apigit 中的 API 治理

APIGit

2023-07-20

api-governance

如何找到API治理?

当您选择编辑规范文件时,您会发现几个不同的视图。其中之一称为治理。在此视图中,您将看到审核结果,并能够根据您设置的规则为每个警告或错误提供评论。

api-governance-1

API 治理将有何帮助?

以下是 API 最佳实践的要点:

  • 信息: 确保每个 API 都具有标题、描述和其他必要信息等基本属性。

  • 版本控制: 对每个 API 强制使用标准语义或基于日期的版本控制。

  • 操作: 确保每个单独的操作都包含摘要、描述和 ID。

  • 参数: 标准化参数名称的格式并确保所有参数都有适当的描述。

  • 回应: 倡导跨 API 使用一组通用的状态代码、媒体类型和架构响应。

  • 架构: 使用 JSON 架构组件标准化所有请求和响应架构。

下一步是什么?

目前,我们有一个基本规则,名为OpenAPI Best Practice。将来,我们计划引入更多规则集,包括 OWASP Top 10 Security 和自定义规则集。请继续关注这些即将推出的新增内容。

API 治理不仅仅包括设计和标准;它围绕着赋予人们权力并最大化 API 的价值。通过利用自动化、研讨会和培训课程,API 治理可帮助用户制定安全措施、产品定义和实施策略。为了确保其有效性,了解 API 治理的所有组成部分和影响至关重要。如需进一步指导,请继续关注 Apigit 博客,了解有关重要 API 治理主题的即将发布的帖子。