@oas-typescript/koa v0.14.0
oas-typescript-koa
oas-typescript-koa is a generator for OpenAPI Specification 3 to koa. This tool is powered by openapi-zod-client for the OAS parsing.
Installation
It is recommended to install this as a project dependency so that it can be used in CI consistently.
# With npm.
npm install --save-dev @oas-typescript/koa
# With yarn.
yarn add -D @oas-typescript/koa
CLI guide
Option | Description | Default value |
---|---|---|
--output , -o | The output directory. | (pwd)/oas-typescript |
--app-security-schemes-field | The security scheme field used in the OpenAPI Specification. Mostly useful when you have custom securitySchemes that are not supported by the specification. | securitySchemes |
--app-security-requirements-field | The custom security requirements field used in the OpenAPI Specification. Mostly useful when you have custom security that are not supported by the specification. | security |
--module | The output module. Available values are cjs or esm . | esm |
Generating server stubs
To generate the server stubs, do this command:
npx oas-typescript-koa generate ./api.json --output generated
# Or, using yarn:
yarn oas-typescript-koa generate ./api.json --output generated
# Or, inside the `scripts` in package.json.
oas-typescript-koa generate ./api.json --output generated
The command above will read the Open API Specification api.json
and output them to the generated
folder. The result will be as the following.
generated
├── controllers
│ ├── PetController.ts
│ ├── StoreController.ts
│ └── UserController.ts
├── static
│ ├── checksum.json
│ ├── client.ts
│ ├── controller-types
│ │ ├── PetControllerTypes.ts
│ │ ├── StoreControllerTypes.ts
│ │ └── UserControllerTypes.ts
│ ├── security-schemes.ts
│ ├── router.ts
│ ├── types.ts
│ └── utils.ts
└── middleware-helpers.ts
All files are stubs, except the ones in controllers
folder and middleware-helpers.ts
, where you will need to insert your own logic. The latter is mostly used for validating authorization from the incoming request.
More information
For further documentation, please visit the documentation: https://imballinst.github.io/oas-typescript/docs/nodejs-server-stubs/adapters/koa.
3 months ago
4 months ago
4 months ago
4 months ago
4 months ago
5 months ago
5 months ago
5 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
6 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago
10 months ago