Git Product home page Git Product logo

node-api-example's Introduction

REST API Node Example

Example API built with Node Express, populates an in-memory MongoDB instance with seed data.

Features

  • Web API: Express web framework
  • NoSQL database: MongoDB object data modeling using Mongoose
  • API documentation: with swagger-jsdoc and swagger-ui-express
  • Validation: request data validation using Joi
  • Logging: using winston and morgan
  • Error handling: centralized error handling mechanism
  • Process management: advanced production process management using PM2
  • Environment variables: using dotenv and cross-env
  • Sanitizing: sanitize request data against xss and query injection
  • CORS: Cross-Origin Resource-Sharing enabled using cors
  • Compression: gzip compression with compression
  • Testing: unit and integration tests using Jest
  • Code coverage: using coveralls
  • Linting: with ESLint and Prettier
  • Editor config: consistent editor configuration using EditorConfig

Getting Started

npm install

Set the environment variables:

cp .env.example .env

Start dev via:

npm run dev

Connect to the Swagger UI API documentation:

http://localhost:3000/v1/docs/

node-api-example's People

Contributors

jasonsturges avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.