Skip to content

A code generator for express-openapi to start from an OpenApi v2 specification

License

Notifications You must be signed in to change notification settings

progether-as/express-openapi-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

express-openapi-generator

This is a code generator for express-openapi. To generate (and update) an express-openapi project from a OpenApi v2 specification file.

Install & usage

Use within your server module:

npm install express-openapi-generator
./node_modules/.bin/apigen -a api-doc.yml -t .

Install globally and use anywhere:

npm install -g express-openapi-generator
apigen -a api-doc.yml -t ../path/to/server/code

Current limitations

  • Changed or deleted api endpoints will not automatically be deleted
  • The code is mainly untested

Advantages

  • The endpoint code is updated by modifying the AST of the endpoint file. Custom extensions of the code will be kept over updated, allowing the generator to be run multiple times.

About

A code generator for express-openapi to start from an OpenApi v2 specification

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published