0.0.1-dev.0 • Published 9 months ago

@maaspiar/oats v0.0.1-dev.0

Weekly downloads
-
License
GNU3.0
Repository
github
Last release
9 months ago

Usage

npx @maaspiar/oats api.yaml

Contents

Generated server-stub is an ExpressJs app which comes with:

  • Request/Responses Valdiation
  • Typescript interfaces
  • Routing (only methods need to written)
  • Mongoose models Generation (opt-in)
  • VS-Code debugging setup (to be expanded to other IDEs)
  • Deployment Scripts (AWS/GCP)

Update mode

This generator can accomodate updates in your api-spec. Just run the following commands and all the required types, models and routes will be implemented for you:

npx @maaspiar/oats api.yaml --update

Note: Models and interfaces are expected to be overwritten. But as they're autogenerated by the package itself no apparent difference would be observed

Credits

This wouldn't be possible without the following projects:

Special thanks to team@create-t3-app