使用Spectral优化AWS API Gateway的性能 | Stoplight

创建OpenAPI文档的主要目的是通过下游工具实现任务自动化并简化OpenAPI的支持日益完善，但仍存在一些可能导致意外结果的局限性。

OpenAPI文档的局限性

在使用OpenAPI文档时，以下局限性需要特别注意：

• 型号名称只能包含字母数字字符。
• 缺乏对某些OpenAPI关键字的支持，例如鉴别器、弃用、独占最小值等。
• 不支持OpenAPI 3.1版本。

虽然这些限制在文档中有所提及，但API部署到网关时，可能会因忽略这些问题而导致意外结果。

使用Spectral优化AWS API Gateway的性能

为了帮助开发团队避免这些问题，Stoplight Platform基于Andy Lockran的工作，推出了一套公共风格指南。通过这些规则，Spectral可以在AWS API Gateway之前，确保团队遵循最佳实践。以下是一些关键规则的快速概览：

OpenAPI版本

AWS 设计API时，可以通过规则强制仅使用此版本，以确保兼容性。

缺少关键字支持

AWS API Gateway不支持以下关键字：

• default（默认值）
• exclusiveMinimum（排除最小值）
• exclusiveMaximum（排除最大值）
• readOnly（只读）

避免使用这些关键字可以有效减少潜在问题，确保API消费者的使用体验。

命名和模式

AWS API Gateway对型号名称和路径参数的格式有特定要求。通过规则约束命名和路径格式，可以防止因无效名称或路径导致的部署失败。

如何快速启用Stoplight风格指南

以下是使用Stoplight平台快速启用AWS API Gateway风格指南的步骤：

1. 进入Stoplight工作区。
2. 创建一个风格指南项目，或编辑已有的API项目。
3. 选择管理风格指南。
4. 从公共风格指南列表中启用“AWS API Gateway”规则。

通过这些步骤，您可以轻松将Spectral集成到开发流程中，确保API设计和部署的高效性和一致性。

通过遵循这些规则，开发团队可以有效避免因OpenAPI文档限制而引发的问题，从而提升AWS API Gateway的性能和稳定性。如果您有其他建议或需要添加的规则，请随时提供反馈。

原文链接: https://blog.stoplight.io/work-better-with-aws-api-gateway-using-spectral-1