打开API 3.x

篮子分析器 用于 OpenAPI 3.x 服务定义. 这个解析器可以与任何"篮子"生成器相配合,将一个OpenAPI 3.x文档翻译为其他文物,包括服务器,客户端,以及人可读文档.

快速启动

以下示例将 OpenAPI doc 转换为类型 :

1. 保存 https://petstore.swagger.io/v2/swagger.json 作为 petstore.json 在您的项目根.
2. 安装软件包 : npm install -g basketry @basketry/openapi-3 @basketry/typescript
3. 生成代码 : basketry --source petstore.json --parser @basketry/openapi-3 --generators @basketry/typescript --output src

当最后一步运行时,篮子会解析出源文件(petstore.json)使用指定的解析器(@basketry/openapi-3)然后运行每个指定的生成器(在此情况下) @basketry/typescript)写入输出文件夹(src) (中文(简体) ).

对于贡献者:

运行此工程

1. 安装软件包 : npm ci
2. 构建代码 : npm run build
3. 运行它! npm start

注意 lint 脚本运行于 build。可自动固定的起伏或格式化错误可以通过运行来修正 npm run fix。 。 。 .

创建和运行测试

1. 通过创建文件添加测试 .test.ts 后缀
2. 运行测试 : npm t
3. 测试覆盖率可在 /coverage/lcov-report/index.html

发布新软件包版本

1. 创建新版本
   1. 导航到 版本工作流程 从动作标签.
   2. 手动发送行动并附上适当的投入
   3. 这将创建一个带有新版本的 PR
2. 向国家预防机制公布
   1. 审查和合并公关
   2. 这个 发布工作流程 将创建一个 git 标签并发布关于国家预防机制的软件包

创建于 发电机控制台