MediaComem / comem-rest-demo

Demonstration REST API implemented with Express

COMEM+ REST Demo

A demonstration RESTful API implemented with Express.

• Requirements
• Usage
• Configuration
• API Resources
• Automated tests

Requirements

• Node.js 14.x
• MongoDB 4.x

Usage

# Clone the application.
git clone [e-mail]:MediaComem/comem-rest-demo.git

# Install dependencies.
cd comem-rest-demo
npm ci

# Start the application in development mode.
DEBUG=demo:* npm start

Visit http://localhost:3000.

To automatically reload the code and re-generate the API documentation on changes, use npm run dev instead of npm start.

Configuration

The application will attempt to connect to the MongoDB database at mongodb://localhost/comem-rest-demo by default.

Use the $DATABASE_URL or the $MONGODB_URI environment variables to specify a different connection URL.

API Resources

This API allows you to work with Movies and People. A Movie MUST have one director (who is a Person).

Read the full documentation to know more.

Automated tests

This application has an automated test suite which you can run with npm test.

It will attempt to connect to the MongoDB database at mongodb://localhost/comem-rest-demo-test.

The tests are implemented with Mocha, Chai and SuperTest.