rcmontgo / library-api

An api to manage books and their authors.

Library API

An api to manage books and their authors.

Getting Started

This section is intended for software developers. If you have rights to the repo, simply clone the repo. If you do not have rights to the repo, you may fork the repo and clone your fork.

$ git clone <clone url>
$ cd libary-api
$ npm install

Environment Variables

You'll need to create a local .env file to store your application's secret. Follow these steps to generate and store the secrets.

0. Create a COUCH_URL environment variable: Using Cloudant for example or a local instance of CouchDB, create an API key for the database. Store the key and password within your .env file. Use the key and password to create an environment variable named COUCH_URL using this pattern COUCH_URL=https://<key>:<password>@<your base url>/.

Example

COUCH_URL=https://sdfrtrerdfsxdnorth:[e-mail]/

0. Create a PORT environment variable used by the client application to connect and communicate with your api.

Example

PORT=4000

0. Create a COUCH_DATABASE environment variable. The name of the database.

Example

COUCH_DATABASE=library

Starting the api

Run the following command to start the api on localhost:4000.

$ npm start

Endpoints

Authors

Create a authors - POST /authos

Example

POST /authors

{
  "author": "author_aldous_huxley";
  "name" :"Aldous Huxley",
  "type": "author",
  "placeOrBirth":"London"
}

Response 200

{
  "ok": true,
  "id": "author_aldous_huxley",
  "rev": "1-A6157A5EA545C99B00FF904EEF056KFRT"
}

Get a author - GET /author/{id}

Retrieves a single author by the author {id} route parameter.

Example

GET /author/author_aldous_huxley

Response 200

{
  "author": "author_aldous_huxley";
  "name" :"Aldous Huxley",
  "type": "author",
  "placeOrBirth":"London"
}

Route Parameters

• id - used to identify a author in the collection of authors.

Update a book - PUT /authors/{id}

Updates a single author using the author {id} route parameter.

Delete a book - DELETE /authors/{id}

Deletes a single author using the author {id} route parameter.

Example

DELETE /author/author_aldous_huxley

Response 200

{
  "ok": true,
  "id": "author_aldous_huxley",
  "rev": "2-9AF304BE281790604D1D8A4B0F4C9ADB"
}

List the books - GET /authors

TODO: Search the books = GET /authors?[books][placeOrBirth]

Query Parameters

• author
• publisher
• genre

Example GET \authors?placeOrBirth=London

Books

Create a book - POST /authors

Add a book to the collection of books by providing a new book resource in the request body.

Books

Create a book - POST /books

Add a book to the collection of books by providing a new book resource in the request body.

Example

POST /books

{
  "title": "A Brave New World",
  "author": "author_aldous_huxley",
  "type": "book",
  "publisher": "Penguin Books",
  "ISBN": "12947281",
  "genre": "Fiction",
  "description": "Brave New World is a novel written in 1931 by Aldous Huxley, and published in 1932. Set in London in the year AD 2540 (632 A.F.—'After Ford'—in the book), the novel anticipates developments in reproductive technology, sleep-learning, psychological manipulation, and classical conditioning that are combined to make a profound change in society.",
  "rating": 95,
  "prices": [
    {"type": "paperback", "price": 9.99},
    {"type": "hardback", "price": 19.99},
    {"type": "audio", "price": 19.99},
    {"type": "kindle", "price": 12.99}
  ]
}

Response 200

{
  "ok": true,
  "id": "book_brave_new_world",
  "rev": "1-A6157A5EA545C99B00FF904EEF05FD9F"
}

Get a book - GET /books/{id}

Retrieves a single book by the book {id} route parameter.

Example

GET /books/book_brave_new_world

Response 200

{
  "_id": "book_brave_new_world",
  "_rev": "2-e158939dfabc095988f9f4ddaa0e942e",
  "title": "A Brave New World",
  "author": "author_aldous_huxley",
  "type": "book",
  "publisher": "Penguin Books",
  "ISBN": "12947281",
  "pages": 254,
  "genre": "Fiction",
  "description": "Brave New World is a novel written in 1931 by A Huxley, and published in 1932. Set in London in the year AD 2540 (632 A.F.—'After Ford'—in the book), the novel anticipates developments in reproductive technology, sleep-learning, psychological manipulation, and classical conditioning that are combined to make a profound change in society.",
  "rating": 95,
  "prices": [
    {
      "type": "paperback",
      "price": 9.99
    },
    {
      "type": "hardback",
      "price": 19.99
    },
    {
      "type": "audio",
      "price": 19.99
    },
    {
      "type": "kindle",
      "price": 12.99
    }
  ]
}

Route Parameters

- `id` - used to identify a book in the collection of books.

Update a book - PUT /books/{id}

Updates a single book using the book {id} route parameter.

Delete a book - DELETE /books/{id}

Deletes a single book using the book {id} route parameter.

Example

DELETE /books/book_brave_new_world

Response 200

{
  "ok": true,
  "id": "book_brave_new_world",
  "rev": "2-9AF304BE281790604D1D8A4B0F4C9ADB"
}

List the books - GET /books

TODO: Search the books = GET /books?[author][genre][publisher]

Query Parameters

- author
- publisher
- genre

Example `GET \books?author=William F Buckley`