频谱AWS API网关规则集
在使用AWS API Gateway时,它使用了许多与OpenAPI标准相距甚远的特性。
有用的是,这里记录了这些特性 AWS API网关重要说明,但 API开发人员很容易忘记或忽略它们。
光谱
光谱 是一个开源API检查器。
Spectral是一个开源的JSON/YAML过滤器,它允许你为你的结构化数据创建风格指南;像OpenAPI/AsyncAPI/RAML描述,Kubernetes配置,GitHub动作,你能想到的,光谱可以帮助你检测它。除了确保它们“技术上正确”之外,还要确保它们是有用的。
试试吧:
如果您已经安装了npx,那么您可以用一个命令来运行这个规则集,替换$your_api。yml -与您的API定义:
npx spectral lint -r https://raw.githubusercontent.com/andylockran/spectral-aws-apigateway-ruleset/main/aws_important_notes.yml $your_api.yaml
指令
要使用该规则集,只需扩展.spectral。通过添加对该规则集的引用来创建Yml规则集,例如:
extends:
- spectral:oas
- spectral-aws-apigateway-ruleset
它直接从npm中提取定义,你甚至不需要安装它!
NPM包
spectral-aws-apigateway-ruleset
看到的: npm的谱指令 了解更多详情。
贡献
这些规则的严格程度已经根据我自己的用法进行了调整。如果您认为严重性需要更改,或者更喜欢更具描述性的错误消息,请提交PR。
有关如何这样做的说明,请参阅 自定义规则集 在光谱网站上。
Treeware
这个包裹是 Treeware. 如果您在生产中使用它,那么我们要求您 给世界买棵树 感谢我们的工作。通过为Treeware森林做出贡献,您将为当地家庭创造就业机会并恢复野生动物栖息地。