02.09 Write up REST endpoints

Details
Parent Category: Server related

 

Endpoints

 

Status

GET /status

Returns the status of the API

 

List of books

GET /books

Return a list of books

Optional query parameters

  • type: fiction or non-fiction
  • limit: a number between 1 and 20

 

Get a single book

GET /books/:bookId

Retrieve detailed information about a book

 

Submit an order

POST /orders/

Authorization: Bearer <YOUR TOKEN>

{

    "bookId": 1,

    "customerName": "John"

}

 

Get an order

GET /orders/:orderId

Allows you to view all existing orders. Requires authentication.

 

Update an order

PATCH /orders/:orderId

Update an existing order. Requires authentication.

 

API AUTHENTICATION

 

Submit an order

To submit or view an order, you need to register your API client.

 

POST /api-clients/

 

The request body needs to be in JSON format and include the following properties

  • clientName - String
  • clientEmail - String

 

Example

{
  "clientName": "Ivan",
  "clientEmail": "bobATbob.com"
}

 

 

  VARIABLE INITIAL VALUE CURRENT VALUE
  baseURL http://blah.com http://blah.com
  accessToken --- 23o32jo32joijfoijsdodsf
       

 

You don't want to check in your accessToken

 

NOTE: For a endpoint that needs a token you can add one in the Authorisation tab.

Token: {{accessToken}}