very-express
v0.6.14-alpha
Published
based on json schema and openapi, generate Express RestApi server with mongoDb
Readme
VeryExpress
VeryExpress is a generator that reads JSON Schema and produces a complete Express.js REST API (TypeScript, Mongoose, RBAC, OAuth2, Swagger).
Features
- Generate Express TypeScript server from JSON Schema
- API validation with
express-validator - OpenAPI generation + Swagger UI
- OAuth via
passport(OAuth2) - Mongoose (MongoDB) and TypeORM(SQL) DB driver
- CLI for quick project scaffolding
Quick Start
- Install globally (optional):
npm i -g very-expressOr run via npx:
npx very-express- Initialize config in project root:
vex -initThis creates vex.config.json.
- Create schema directory (or use directory set in
vex.config.json):
mkdir jsonSchemaAdd your JSON Schema files into
jsonSchema/following schema guide: docs/vexJsonSchema.mdGenerate app:
vex- Run generated app:
cd output
npm i
npm run devNotes:
- suffix
*.gen.tsis regenerated by the generator. edit at own risk.
Docs
- Schema reference: docs/vexJsonSchema.md
- Contributing: docs/CONTRIBUTING.md
- Usage & CLI: docs/USAGE.md
- Changelog: docs/CHANGELOG.md
- Release notes: docs/releaseNote/
