02strich-spectral-aws-apigateway-ruleset

中文文档
1.7.4-1发布于 2023/03/08Apache-2.0CommonJS

一个频谱规则集,用于强制执行AWS API网关

中文使用文档
文档目录5 节
  1. 光谱
  2. 指令
  3. NPM包
  4. 贡献
  5. Treeware

频谱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森林做出贡献,您将为当地家庭创造就业机会并恢复野生动物栖息地。

版本与发布记录

02strich-spectral-aws-apigateway-ruleset 共发布 2 个版本,首次发布于 2023/03/08;过去 12 个月发布了 0 个版本。

版本发布日期距今
1.7.4-1latest2023/03/083 年前
1.7.42023/03/083 年前

关于 02strich-spectral-aws-apigateway-ruleset 的常见问题

02strich-spectral-aws-apigateway-ruleset 是什么?

一个频谱规则集,用于强制执行AWS API网关

如何安装 02strich-spectral-aws-apigateway-ruleset?

在项目目录运行 npm install 02strich-spectral-aws-apigateway-ruleset,或使用 pnpm add / yarn add / bun add。

02strich-spectral-aws-apigateway-ruleset 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/02strich-spectral-aws-apigateway-ruleset 是否存在。

02strich-spectral-aws-apigateway-ruleset 支持 ESM 还是 CommonJS?

以 CommonJS 形式发布,可以直接 require();在 ES Module 项目中也可以用 import 引入(Node.js 会把 module.exports 作为默认导出)。

02strich-spectral-aws-apigateway-ruleset 可以商用吗?

02strich-spectral-aws-apigateway-ruleset 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

02strich-spectral-aws-apigateway-ruleset 还在维护吗?

最新版本 1.7.4-1 发布于 2023/03/08(3 年前);至今共发布 2 个版本,其中过去 12 个月发布了 0 个;首次发布于 2023/03/08。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。