Git Product home page Git Product logo

simple-api-book's Introduction

Book API

A simple REST API to manage a collection of books.

Features

  • Get all books
  • Get a book by ID
  • Add a new book
  • Update a book by ID
  • Delete a book by ID

Requirements

  • Node.js (version 12 or higher)
  • npm (version 6 or higher)

Installation

  1. Clone the repository
git clone https://github.com/your-username/book-api.git
cd book-api
  1. Install dependencies
npm install
  1. Run application
nodemon .

Endpoints

  • GET /books
curl -X GET http://localhost:3000/books

response

{
    "books": [
        {
            "id": 1,
            "title": "Laskar Pelangi",
            "author": "Andrea Hirata"
        },
        {
            "id": 2,
            "title": "Naruto",
            "author": "Masashi Kishimoto"
        }
    ]
}
  • GET BY ID /books/find?id=1
  curl -X GET http://localhost:3000/books/find?id=1

response

{
    "book": {
        "id": 1,
        "title": "Laskar Pelangi",
        "author": "Andrea Hirata"
    }
}
  • ADD NEW BOOK /books
curl -X POST http://localhost:3000/books -H "Content-Type: application/json" -d '{"title": "New Book", "author": "Author Name"}'

response

{
    "book": {
        "id": 3,
        "title": "new book 1",
        "author": "john"
    }
}
  • UPDATE BOOK /books/1
curl -X PUT http://localhost:3000/books/1 -H "Content-Type: application/json" -d '{"title": "new book 2", "author": "john"}'

response

    "book": {
        "id": 1,
        "title": "new book 2",
        "author": "john"
    }
}

-- DELETE BOOK /books/1

curl -X DELETE http://localhost:3000/books/1

response

The book has been deleted.

simple-api-book's People

Contributors

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