demandre/articleApi

Article API

Overview

The API allows users to retrieve all of the article of the application in micro service through a REST architecture.

Also allows to create users. Will be useful soon with authentification.

[POST] Create user

Allows the creation of a single user.

Requires authentication ?	No
Who can use it ?	Owner and users
Response formats	application/json

• HTTP request : POST → user/create

Parameters :

{
  'name': String, // Required
  'age': Number, // Optional
  'sexe': String // Optional
}

Response :

  {
    _id: Object_ID,
    name: String,
    age: String,
    sexe: String
  }

[POST] Create article

Allows the creation of a single article.

Requires authentication ?	No
Who can use it ?	Owner and users
Response formats	application/json

• HTTP request : POST → article/create

Parameters :

{
  'title': String, // Required
  'content ': String, // Required
  'cover_img_url': String // Optional
}

Response :

  {
    comment: Array,
    _id: Object_ID,
    title: String,
    content: String,
    cover_img_url: String,
    date: String
  }

[GET] Delete article

Allows to delete a single article.

Requires authentication ?	No
Who can use it ?	Owner and users
Response formats	application/json

• HTTP request : GET → article/delete/:id

Parameters :

No parameters

Response :

  {
    n: Number,
    ok: Number,
    deletedCount: Number
  }

[POST] Update article

Allows the creation of a single article.

Requires authentication ?	No
Who can use it ?	Owner and users
Response formats	application/json

• HTTP request : POST → article/update/:id

Parameters :

{
  'title': String, // Optional
  'content ': String, // Optional
  'cover_img_url': String // Optional
}

Response :

  {
    comment: Array,
    _id: Object_ID,
    title: String,
    content: String,
    cover_img_url: String,
    date: String
  }

[GET] Search article

Allows the creation of a single article.

Requires authentication ?	No
Who can use it ?	Owner and users
Response formats	application/json

• HTTP request : GET → article/search/

Parameters :

{
  'title': String, // Optional
  'content ': String, // Optional
  'cover_img_url': String // Optional
}

Response :

  {
    comment: Array,
    _id: Object_ID,
    title: String,
    content: String,
    cover_img_url: String,
    date: String
  }

[GET] Show article

Allows to get single article data.

Requires authentication ?	No
Who can use it ?	Owner and users
Response formats	application/json

• HTTP request : GET → article/show/:id

Parameters :

No parameters

Response :

  {
    _id: Object_ID,
    title: String,
    content: String,
    cover_img_url: String,
    date: String,
    comment: Array
  }

Requirements

• node 10
• npm
• yarn
• git
• mongodb (please configure config.js for link mongodb with your localhost)

Install

yarn install

Build

yarn build

Start (prod mode)

yarn start

Start (dev mode)

yarn dev

Launch tests

yarn test