@open-api

一个用于在 Node 中支持 OpenAPI 的各种包的 Monorepo。

Express 快速入门

• 参见 express-openapi   

Koa 快速入门

• 参见 koa-openapi   

包列表

• express-openapi
• fetch-openapi
• fs-routes
• openapi-default-setter
• openapi-framework
• openapi-jsonschema-parameters
• openapi-request-coercer
• openapi-request-validator
• openapi-response-validator
• openapi-schema-validator
• openapi-types

开发

这个 monorepo 使用 lerna 进行开发。请查看根目录的 package.json 文件获取有用的脚本。

贡献者的典型工作流程

假设你正在处理 ./packages 下的某个包。以下是你需要做的：

1. cd open-api
2. npm run bootstrap
3. npm t
4. 进行修改。
   1. 不要修改 package.json 中的版本号。 维护者会在你的 PR 合并后处理这个问题。
5. 当你对修改满意时：
   1. 创建一个新分支 git checkout -b my-branch（如果你还没有这样做）。
   2. ./bin/commit packages/<你正在处理的包> '描述你的更改的提交信息。可以是多行。只需用单引号结束，如下所示：'
   3. 将你的更改推送到你的 fork
   4. 开启一个 PR。

bin

为了便于这个 monorepo 的开发，我们创建了几个脚本（见 ./bin）。它们假设你的 $PWD 是仓库的根目录。以下是常见操作的简要概述：

• 提交对某个包的更改 - ./bin/commit packages/<要提交的包> '提交信息'（提交信息前会加上包名，例如 <要提交的包>: 提交信息）
• 这些脚本减少了样板代码，并在叶子仓库的 npm 脚本中被调用。
  • nyc
  • tsc
  • mocha

许可证

MIT 许可证 (MIT)

版权所有 (c) 2018 Kogo Software LLC

特此免费授予任何获得本软件副本和相关文档文件（"软件"）的人不受限制地处置该软件的权利，包括不受限制地使用、复制、修改、合并、发布、分发、再许可和/或出售该软件副本，以及再授权被配发了本软件的人如上的权利，须在下列条件下：

上述版权声明和本许可声明应包含在该软件的所有副本或实质成份中。

本软件是"如此"提供的，没有任何形式的明示或暗示的保证，包括但不限于对适销性、特定用途的适用性和非侵权性的保证。在任何情况下，作者或版权持有人都不对任何索赔、损害或其他责任负责，无论这些追责来自合同、侵权或其它行为中，还是产生于、源于或有关于本软件以及本软件的使用或其它处置。