@omer-x/next-openapi-interface-generator
v0.11.0
Published
OpenAPI interface generator for Next.js
Downloads
209
Maintainers
Readme
Next OpenAPI Interface Generator
This script automates the generation of documentation and TypeScript interfaces for a service, making it easier to maintain and interact with the service in a TypeScript environment.
Installation
npm install @omer-x/next-openapi-interface-generator
Usage
generate-service-interface --output <output_directory> --framework <framework_name> --schemas <schemas_directory>
Options
--output
,-o
: Specify the output directory. Default:dist
--framework
,-f
: (Optional) Specify the target framework. Options:next
--schemas
,-s
: (Optional) Specify the path for predefined zod schemas. Multiple paths can be provided, separated by commas.--definer
: (Optional) Name of the function that was exported from theNext OpenAPI Route Handler
Example
generate-service-interface -o dist -f next -s src/models
generate-service-interface -o dist -f next -s src/models/user,src/models/message
generate-service-interface -f next --definer createRoute
Contributing
Contributions are welcome! Please feel free to submit a pull request or open an issue if you find any bugs or have any suggestions for improvement.
License
This project is licensed under the MIT License - see the LICENSE file for details.