Git Product home page Git Product logo

notes-restful-api's Introduction

API Installation

git clone https://github.com/mazufik/notes-restful-api.git

cd notes-restful-api

npm run start

API Spec

Create Notes

Request:

  • Method : POST
  • Endpoint : /api/notes
  • Header :
    • Content-Type : application/json
    • Accept : application/json
  • Body :
{
  "title": "string",
  "tags": "array of string",
  "body": "string"
}

Response body success:

{
  "code": "number",
  "status": "string",
  "message": "string",
  "data": {
    "id": "string",
    "title": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "tags": "array of string",
    "body": "string"
  }
}

Response body error:

{
  "code": "number",
  "status": "string",
  "message": "string"
}

Get Note

Request:

  • Method : Get
  • Endpoint : /api/notes/{id}
  • Header :
    • Accept : application/json

Response:

{
  "code": "number",
  "status": "string",
  "message": "string",
  "data": {
    "id": "string",
    "title": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "tags": "array of string",
    "body": "string"
  }
}

Response error:

{
  "code": "number",
  "status": "string",
  "message": "string"
}

Update Note

Request:

  • Method : PUT,
  • Endpoint : /api/notes/{id}
  • Header :
    • Content-Type : application/json
    • Accept : application/json
  • Body :
{
  "title": "string",
  "tags": "array of string",
  "body": "string"
}

Response body success:

{
  "code": "number",
  "status": "string",
  "message": "string",
  "data": {
    "id": "string",
    "title": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "tags": "array of string",
    "body": "string"
  }
}

Response body error:

{
  "code": "number",
  "status": "string",
  "message": "string"
}

Delete Note

Request:

  • Method : DELETE
  • Endpoint : /api/notes/{id}
  • Header :
    • Accept : application/json

Response:

{
  "code": "number",
  "status": "string",
  "message": "string"
}

notes-restful-api's People

Contributors

mazufik avatar

Watchers

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.