Node-Api

Node-Api is an auto api generator, for use you only must set the models, also provide an easy middleware integrate to add services (auth, log, etc).

Installation

Node Api requires Node.js v4.4+ to run and requires MongoDb.

Run

node index.js

To run without Docker the unique of you need to do is "node index. js", before of this you should set environment variables for config, port the app, url of MongoDb, etc. If you don't set all environment variables doesn't matter, because all have default values.

How to use

To use you must put a model file into the path "app/generator/models/yourfile.json", this file must be a structure like:

{
	"name": "User",
	"structure": {
		"name": {
			"type":"String"
		},
		"label": {
			"type": "String"
		},
		"account": { 
			"type": "ObjectId", 
			"ref": "Account" 
		}
	},
	"detail": {
		"validate":[
		    { "name":"id", "source":"params",  "rules" : { "presence": true, "length": { "is": 24 } } }
		], 
		"select": {
			"account": false 
		}, 
		"populate": ["Account"] 
	},
	"list":{
		"paginate": true,
		"search": true,
		"select": {
			"name": false,
			"account": false
		}, 
		"populate": ["Account"], 
		"service": [
			{
				"name": "auth", 
				"method":"ifAuth"
			}
		] 
	},
	"update":{},
	"delete":{},
	"create":{}
}

This json represents the models that the api needs to start:

• name: field that you use for your path, in this case the path is "/user" because apply lowercase.
• structure: The structure represents the fields of the schema for store/update/find in MongoDb, this structure model support all the types of Mongoose Date/String/Number/Mixed/ObjectId.
• list: List represents GET method and return [] of documents related with the structure of the model and the url that is used in this case according to the model "User" is "/user".
• detail: Detail represents GET method and return {} of document related with the structure of the model and the url that is used in this case according to the model "User" is "/user/:id".
• create: Create represents POST method and return {} of document related with the structure of the model and the url that is used in this case according to the model "User" is "/user".
• delete: Delete represents DELETE method and return status: 204, and the url that is used in this case according to the model "User" is "/user/:id".
• update: Update represents PUT method and return {} document related with the structure of the model and the url that is used in this case according to the model "User" is "/user/:id".

In all of the methods you can populate fields, disable method set "unable": false, and set or unset fields in response with select: true | false in some method. Also, you can add a middleware, set element in array "service", you must put the name file and method of the service, this file must be in "/service", you can see an example of this in "/service/auth". Also, you can validate fields of a request in params, query and body, put objects into field "validate" of contains name, source, rules, the rules is the restriction of the field in the request, the format of you can apply in rules it's Validate Js.

How to use filters ( list )

In method "list" you can set different parameters to sort or filter the return documents. The parameters of you can set are:

• page -> "/user?page=2"
• limit -> "/user?limit=5"
• search -> "/user?search={"name":"ju"}" with this implementation you can do a text search, in this example search all names of contains "ju", support multiple key search. The search can be disable put in the method search: false.

Also, you can filter the result put the field's value through query, for example "/user?name=juan", in this example filter all the documents with only have names "Juan", only can set fields are in the structure of the model.

Tech

Node-Api uses a number of open source projects to work properly:

• NodeJs - Server Tecnology for api.
• MongoDB - Database of the api use.
• Restify - Framework of NodeJs for handling http Request.
• Mongoose - Library for Mongodb.

Enviroment Variables

• NODE_ENV
• PORT
• IP
• MONGODB_URI
• LOG_PATH (this is a path of you want to store errors)

Docker

Node-Api is very easy to install and deploy in a Docker container.

By default, the Docker will expose port 80, so change this within the Dockerfile if necessary. When ready, simply use the Dockerfile to build the image.

cd project
docker build -t <youruser>/tag:latest .

docker run -d -p 80:80 --restart="always" <youruser>/tag:latest

Verify the deployment by navigating to your server address in your preferred browser.

Version

0.2.0

Todos

• Write Tests
• Think releases

License

MIT