Skip to content

wlopes/simple_rest_api

Repository files navigation

simple_rest_api

Simple Rest API auto-generated by a config file

This is a test to generate API endpoints based only a config file. Is just a study about express and mongoose. I'm using the Cloud service of MongoDB to avoid database great configurations

Requirements

  • nodejs
  • npm

Installation

  • Clone the repository
  • run npm install
  • run npm install -g nodemon
  • create a config.json file based on config-example.json
  • create a account on https://cloud.mongodb.com/
  • create a Project (get the slug of the project name)
  • create a password to the Project in Database Access
  • Set the projectname and the password on configs file
  • Create your own collections

Running

  • run node index.js or nodemon
  • check the configured route (example http:localhost:3000)
  • check the automatic documentation ~/doc
  • check the routes ~/routes
  • test the CRUD

About

Simple Rest API auto-generated by a config file

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published