express_movies_api.md

create-raml

back to readme

Movies database API example ( GET, POST, DELETE methods; RAM data storage )

Result example as html: Movies Database API documentation

Install modules

npm install -S express
npm install -S body-parser
npm install -S create-raml

API script

var express = require('express');
var bodyParser = require('body-parser');
var Raml = require('create-raml');

var app = express();
app.use(bodyParser.json());

var raml = new Raml({
  express: app,
  path: '/api.raml', // path to API RAML
  storeResponses: true, // store first response as example
  guessAll: true, // make description quite pretty
  title: 'Movies Database',
  baseUri: 'http://127.0.0.1:3000',
  version: 'v1',
});

var movies = {
  1: { name: 'Shaun of the Dead', year: 2004 },
  2: { name: 'Hot Fuzz', year: 2007 },
};

app.get('/movies', function (req, res) { res.json(movies); });

app.post('/movies', function (req, res) {
  if (movies[req.body.id]) res.status(409).json({ error: 'id exists' });
  else res.status(201).json(movies[req.body.id] = req.body);
});

app.get('/movies/:id', function (req, res) {
  if (movies[req.params.id]) res.json(movies[req.params.id]);
  else res.status(404).json({ error: 'movie not found' });
});

app.delete('/movies/:id', function (req, res) {
  if (movies[req.params.id]) res.json({ ok: delete movies[req.params.id] });
  else res.status(404).json({ error: 'movie not found' });
});

app.get('/movies/:id/actors', function (req, res) { res.json({}); });

app.listen(3000, function () {
  console.log('Example app listening on port 3000!');
});

Workflow requests

Get all movies

curl 127.0.0.1:3000/movies

{"1":{"name":"Shaun of the Dead","year":2004},"2":{"name":"Hot Fuzz","year":2007}}

Get movie by id

curl 127.0.0.1:3000/movies/1

{"name":"Shaun of the Dead","year":2004}

Get not exists movie

curl 127.0.0.1:3000/movies/3

{"error":"movie not found"}

Add movie

curl -X POST -H "Content-Type: application/json" -d '{"id":3,"name":"The World\u0027s End","year":2013}' 127.0.0.1:3000/movies

{"id":3,"name":"The World's End","year":2013}

curl 127.0.0.1:3000/movies

{"1":{"name":"Shaun of the Dead","year":2004},"2":{"name":"Hot Fuzz","year":2007},"3":{"id":3,"name":"The World's End","year":2013}}

Add movie with exists id

curl -X POST -H "Content-Type: application/json" -d '{"id":3,"name":"Paul"}' 127.0.0.1:3000/movies

{"error":"id exists"}

curl -X POST -H "Content-Type: application/json" -d '{"id":4,"name":"Paul"}' 127.0.0.1:3000/movies

{"id":4,"name":"Paul"}

Delete movie by id

curl -X DELETE 127.0.0.1:3000/movies/4

{"ok":true}

Delete not exists movie

curl -X DELETE 127.0.0.1:3000/movies/4

{"error":"movie not found"}

Get list of actors (not implemented)

curl 127.0.0.1:3000/movies/1/actors

{}

Get RAML

curl 127.0.0.1:3000/api.raml

#%RAML 1.0
title: Movies Database
baseUri: http://127.0.0.1:3000
version: v1

types:

/api.raml:
  get:
    description: List all /api.raml

/movies:
  get:
    description: List all movies
    responses:
      200:
        body:
          application/json:
            example: |
             {
               "1": {
                 "name": "Shaun of the Dead",
                 "year": 2004
               },
               "2": {
                 "name": "Hot Fuzz",
                 "year": 2007
               }
             }
  post:
    description: Insert a new record in to movie collection
    body:
      application/json:
        type: 
        example: |
         {
           "id": 3,
           "name": "The World's End",
           "year": 2013
         }
    responses:
      201:
        body:
          application/json:
            example: |
             {
               "id": 3,
               "name": "The World's End",
               "year": 2013
             }
      409:
        body:
          application/json:
            example: |
             {
               "error": "id exists"
             }
    
  /{id}:
    get:
      description: Get movie with ID {id}
      responses:
        200:
          body:
            application/json:
              example: |
               {
                 "name": "Shaun of the Dead",
                 "year": 2004
               }
        404:
          body:
            application/json:
              example: |
               {
                 "error": "movie not found"
               }
    delete:
      description: Delete movie with ID {id}
      responses:
        200:
          body:
            application/json:
              example: |
               {
                 "ok": true
               }
        404:
          body:
            application/json:
              example: |
               {
                 "error": "movie not found"
               }
      
    /actors:
      get:
        description: List of actors that movie {id} has
        responses:
          200:
            body:
              application/json:
                example: |
                 {}

Created by

Dimitry, [email protected]

curl -A cv ivanoff.org.ua

back to readme