@sschw/openapi-codegen-cli
v2.1.3
Published
OpenAPI Codegen cli
Downloads
2,013
Maintainers
Readme
This is a fork of the original project openapi-codegen by Fabien BERNARD.
OpenAPI Codegen
Getting started
- Add a
openapi-codegen.config.ts
at the root of your project
// openapi-codegen.config.ts
import { defineConfig } from "@sschw/openapi-codegen-cli";
import {
generateSchemaTypes,
generateReactQueryComponents,
} from "@sschw/openapi-codegen-typescript";
export default defineConfig({
example: {
from: {
source: "github",
owner: "fabien0102",
repository: "openapi-codegen",
ref: "main",
specPath: "examples/spec.yaml",
},
// can be overridden from cli
outputDir: "src/queries",
to: async (context) => {
const filenamePrefix = "example";
// Generate all the schemas types (components & responses)
const { schemasFiles } = await generateSchemaTypes(context, {
filenamePrefix,
});
// Generate all react-query components
await generateReactQueryComponents(context, {
filenamePrefix,
schemasFiles,
});
},
},
});
- Expose openapi-codegen in your
package.json
--- a/package.json
+++ b/package.json
"scripts": {
+ "gen": "openapi-codegen",
}
- Run the generator (
example
is the config key defined in the step 1)
$ yarn gen example
- Start playing! 🥳