https://github.com/wrannaman/generators
API Generator - instantly generate REST and GraphQL APIs (openapi (OAS) 3.0.0)
https://github.com/wrannaman/generators
api-generator generator graphql microservice microservice-framework mit-license nodejs nodejs-development nodejs-server oas oasv3 openapi openapi-generator openapi3 rest swagger-codegen
Last synced: 3 days ago
JSON representation
API Generator - instantly generate REST and GraphQL APIs (openapi (OAS) 3.0.0)
- Host: GitHub
- URL: https://github.com/wrannaman/generators
- Owner: wrannaman
- License: mit
- Created: 2019-06-02T03:05:54.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T17:52:06.000Z (about 2 years ago)
- Last Synced: 2025-02-08T05:11:11.768Z (14 days ago)
- Topics: api-generator, generator, graphql, microservice, microservice-framework, mit-license, nodejs, nodejs-development, nodejs-server, oas, oasv3, openapi, openapi-generator, openapi3, rest, swagger-codegen
- Language: JavaScript
- Homepage: https://noco.io
- Size: 2.34 MB
- Stars: 236
- Watchers: 3
- Forks: 30
- Open Issues: 9
-
Metadata Files:
- Readme: README.api.md
- License: License
Awesome Lists containing this project
README
# Instantly Generate Rest & GraphQL APIs 🔥
[](https://twitter.com/andrewpierno)
[](http://isitmaintained.com/project/sugarkubes/generators "Average time to resolve an issue")
[](http://isitmaintained.com/project/sugarkubes/generators "Percentage of issues still open")
[](https://www.npmjs.com/package/sugar-generate)
[](https://npmcharts.com/compare/sugar-generate?minimal=true)
## Install
```sh
npm i -g sugar-generate
```
## Prereqs
- have mongodb [installed and running](https://treehouse.github.io/installation-guides/mac/mongo-mac.html)!
- have nodejs installed
if you're running mongodb locally and using the docker container, make sure to start mongo using
```sh
sudo mongod --bind_ip_all
```
otherwise you wont be able to connect to mongo from docker.
## Getting Started
1. Create your schema. It could be as simple as:
```json
{
"schema": {
"name": {
"type": "String",
"default": ""
},
"isDead": {
"type": "Boolean",
"default": false
},
"age": {
"type": "Number",
"default": false
}
},
"statics": {}
}
```
You can also provide multiple schemas like the following
```json
[
{
"name": "user",
"schema": {
"name": {
"type": "String",
"default": ""
},
"email": {
"type": "String",
"trim": true,
"required": true,
"unique": true,
"immutable": true
},
"intro": {
"type": "Boolean",
"default": false
},
"sub": {
"one": {
"type": "String",
"trim": true,
"required": true
},
"two": {
"type": "String",
"required": true
},
"three": {
"type": "Number"
}
},
"role": {
"type": "String",
"enum": ["user", "maker"],
"default": "user"
}
},
"statics": {
"statuses": ["created", "under_review", "listed", "deleted"],
"status": {
"active": "active",
"inactive": "inactive",
"deleted": "deleted"
}
}
},
{
"name": "team",
"schema": {
"name": {
"type": "String",
"default": ""
},
"users": {
"type": "ObjectId",
"ref": "Users"
}
}
}
]
```
save this to **monkey.json**
2. generate your api
```sh
sugar-generate \
--schema ./monkey.json \
--destination ./my-monkeys
```
or the short version
```sh
sugar-generate \
-s ./monkey.json \
-d ./my-monkeys
```
**Note this is slightly different than previous versions. The schemas require a name now.**
3. Run or build the docker container and visit [http://localhost:3000](http://localhost:3000)
```sh
cd /my-monkeys
npm i
npm start
# Or build the docker container!
docker build -t myMonkeys:0.1.0 .
```
## Features 🙉
- Generates simple Nodejs code
- Graphql and Rest out of the box
- Uses Mongodb with Mongoose ORM
- Easy to build / deploy
- Dockerfile included
- supports multiple schemas
- Generates CRUD APIs
- create
- get (many, with pagination; supports search, sort, filter, pagination out of the box)
- getOne
- update
- delete
- Generates GraphQL apis for both query and mutation
## What it's good at 🙊
- Generating an initial API
- Microservice oriented
- Ready to deploy (build with docker => deploy)
## What it's not good at (yet) 🙈
- idempotent changes (i.e. it doesn't know if you wrote code in there or changed things around)
- working with modified code
- populating table joins
- custom actions inside controller functions
## TODO
### API
- ~~basic generator rest tests~~
- graphql tests
- other databases?
- **your ideas?**
- middleware for auth, token validation, etc.
## Graphql support
graphql is supported and gets created by default so you can choose between rest and graphql
Graphql is on [http://localhost:3000/graphql](http://localhost:3000/graphql)
## Generated project structure
.
├── configs # Config File
├── connection # DB Connections (mongo, redis)
├── controller # Controllers
│ ├── # Functions (one file, one function) create, delete, update, get, getOne
├── models # DB Models
├── router # Endpoint Routes
├── tests # Single Test File
## Generated tests
** WARNING ** running the tests will pull the config file from **configs/config.json** and clear the DB
```sh
npm run test
```