Skip to content

Latest commit

 

History

History
91 lines (65 loc) · 1.53 KB

API-docs.md

File metadata and controls

91 lines (65 loc) · 1.53 KB
Raw

API specs

host: http://localhost:8000 (Note: https is not supported.)

/knockknock

GET /knockknock
request body: none

response status code: 200
response body: (string)

/books

GET /books
request body: none

response status code: 200
response body: list of books (json)

GET /books/{book-id}
request body: none

response status code: 200
response body: book (json)

example response:

    {
        "author": "Gerald Weinberg", 
        "id": "9b30d321-d242-444f-b2db-884d04a4d806", 
        "pages": 182, 
        "publisher": "Dorset House Publishing", 
        "sub_title": null, 
        "title": "Perfect Software And Other Illusions About Testing", 
        "year": 2008
    }

POST /books
request body: book details (no id) (json)

response status code: 201
response body: id of created book (json)

example response:

    {
        "id": "3612a30e-800f-4f34-8c2c-670fd2f13a01"
    }

DELETE /books/{book-id}
request body: none

requires token
response status code: 200 response body: none

PUT /books/{book-id} requires token
request body: book details (no id) (json)

response status code: 200
response body: updated book (json)

/token

POST /token/{user}
request body: none

response status code: 201
response body: token (json)

example response:

    {
        "token": "AQuKIjKwcktlzEK"
    }

using tokens
Calls requiring a token, expect the user and token to be in the header as key-value pairs:

user: joep
token: owAMNRTDSdjLYtw