Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/theogravity/apifire-server
Generates an express-based API server w/ database migrations and models and an error-handling / logging infrastructure written in Typescript
https://github.com/theogravity/apifire-server
code-generator database express generator nodejs objectionjs openapi openapi-generator openapi3 orm swagger typescript yeoman yeoman-generator
Last synced: 1 day ago
JSON representation
Generates an express-based API server w/ database migrations and models and an error-handling / logging infrastructure written in Typescript
- Host: GitHub
- URL: https://github.com/theogravity/apifire-server
- Owner: theogravity
- License: mit
- Created: 2020-05-17T23:51:29.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-05-11T00:22:08.000Z (over 1 year ago)
- Last Synced: 2024-08-09T14:34:47.972Z (3 months ago)
- Topics: code-generator, database, express, generator, nodejs, objectionjs, openapi, openapi-generator, openapi3, orm, swagger, typescript, yeoman, yeoman-generator
- Language: TypeScript
- Homepage:
- Size: 297 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# generator-apifire-server
[](https://www.npmjs.com/package/generator-apifire-server)
> Generates an express API server written in Typescript with routes/controllers/validation/model/migration generation capabilities.
> Use an OpenAPI 3 yaml file to generate controllers / routers / validators
> Use a yaml to generate objection.js models and knex migrations
Uses the following libraries:
- [`configurity`](https://github.com/theogravity/configurity): Handles configuration
- [`objection-generator`](https://github.com/theogravity/objection-generator): Generates Typescript objection.js models and knex migrations
- [`new-error`](https://github.com/theogravity/new-error): Used to build an error-handling infrastructure
- [`apifire`](https://github.com/theogravity/apifire): Generates Typescript controllers/routers/validators from an OpenAPI 3 spec.
- [`ajv`](https://ajv.js.org/): Validates API request parameters in routers
- [`loglayer`](https://github.com/theogravity/loglayer): Structured logging
See the [`apifire`](https://github.com/theogravity/apifire) for notes on current limitations with using an OpenAPI 3 spec.
The generated project comes with a sample OpenAPI and `objection-generator` spec to quickly get a working server up and running.
## Installation
First, install [Yeoman](http://yeoman.io) and generator-api-server using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).
```bash
npm install -g yo
npm install -g generator-apifire-server
```
Then generate your new project:
```bash
yo apifire-server
```
## Getting To Know Yeoman
* Yeoman has a heart of gold.
* Yeoman is a person with feelings and opinions, but is very easy to work with.
* Yeoman can be too opinionated at times but is easily convinced not to be.
* Feel free to [learn more about Yeoman](http://yeoman.io/).
## License
MIT © [Theo Gravity](https://github.com/theogravity)
[npm-image]: https://badge.fury.io/js/generator-ts-openapi-server.svg
[npm-url]: https://npmjs.org/package/generator-ts-openapi-server
[travis-image]: https://travis-ci.com/theogravity/generator-ts-openapi-server.svg?branch=master
[travis-url]: https://travis-ci.com/theogravity/generator-ts-openapi-server
[daviddm-image]: https://david-dm.org/theogravity/generator-ts-openapi-server.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/theogravity/generator-ts-openapi-server