VeryExpress

this is a generator to make Express REST API app based on Json Schema and Open Api

Why?

bored on writing CRUD API time after time ? then this tool might save your time, all you need is define the Json Schema files.

Quick Start

1. install package globally. npm i -g very-express

2. use cli to initialize configuration file vex.config.json under your project root directory. vex -init

3. create a empty directory and name it as value of vex.config's "jsonSchemaDir", by default jsonSchema. mkdir jsonSchema.

4. you can create your db collection/table now in directory ./jsonSchema just created, refer to Define Json Schmea, every changes require to regenerate app.

5. generate the app with vex.config param. vex

6. you should saw a express typescript app being generated (with src, package.json etc) .

   ├── jsonSchema/  
   │   └── ...
   ├── src/ 
   │   └── ...
   ├── package.json  
   ├── tsconfig.json  
   ├── vex.config.json  
   └── .env  
   

7. start the generated express app.

   npm i  
   npm build    
   npm run start
   

Feature Supported

• generate REST API server
• API Validator by express-validator
• generate OpenApi
• Swagger UI Express
• OAuth by Passport.js
• Database Driver
  • MongoDB by Mongoose

Resource

• Documents

• Road Map

• ReleaseNote

• Discord