Git Product home page Git Product logo

restful-api-example's Introduction

preview

How to start the server

cd server

npm install

npm run dev

Being started correctly information are:

  • [nodemon] starting node server.js

  • Server running on port 5000

Here are my custom api:

Gets Books api

Gets books or some book.

URL

GET localhost:5000/api/books or GET localhost:5000/api/books/:id

Optional Query String Parameters

Name Type Description
id String gets the book by book's id ,eg: when the id is 1 the url will be localhost:5000/api/books/1

Result

HTTP Status Code data
200 [ { "id": "1", "name": "Plot Versus Character", "author": "Jeff Gerke" }, ...]
400 {"message": "Book Not Found"}

Adds Book api

Adds a book by giving it's information.

URL

POST localhost:5000/api/books

Optional Query String Parameters

Name Type Description
name String adds a book with it's name
author String adds a book with it's author

Result

HTTP Status Code data
201 { "id": "1", "name": "Plot Versus Character", "author": "Jeff Gerke" }

Updates Book api

Updates a book by giving it's information.

URL

PUT localhost:5000/api/books/:id

Optional Query String Parameters

Name Type Description
name String updates a book with it's name
author String updates a book with it's author

Result

HTTP Status Code data
200 { "id": "1", "name": "Plot Versus Character", "author": "Jeff Gerke" }
404 { message: "Book Not Found" }

Deletes Book api

URL

Delete localhost:5000/api/books/:id

Name Type Description
id String deletes the book by book's id ,eg: when the id is 1 the url will be localhost:5000/api/books/1

Result

HTTP Status Code data
200 { message: Book ${id} removed }
400 { message: "Book Not Found" }

Common response codes are:

HTTP Status Code Explanation
200
201
400
403
404

restful-api-example's People

Contributors

happyyyt avatar

Stargazers

Roman 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.