Bookstore API

v1 · REST contract · shapes come from the OpenAPI source

AuthSign in and identity▾

POST/auth/registerCreate an account▸

Request body

application/json

schema: Credentials

Responses

Code	Description	Schema
201	Account created	Session
409	Email already registered	Error

POST/auth/loginExchange credentials for a session▸

Request body

application/json

schema: Credentials

Responses

Code	Description	Schema
200	Signed in	Session
401	Bad credentials	Error

CatalogBooks and authors▾

GET/booksList and search books▸

Parameters

Name	In	Type	Description
q	query	string	Full-text query
limit	query	integer	Page size, max 100

Responses

Code	Description	Schema
200	A page of books	Book[]

GET/books/{id}Get one book▸

Parameters

Name	In	Type	Description
id *	path	ULID	Book id

Responses

Code	Description	Schema
200	The book	Book
404	No such book	Error

POST/booksAdd a book🔒 auth▸

Request body

application/json

schema: BookInput

Responses

Code	Description	Schema
201	Book created	Book
401	Not signed in	Error

PATCH/books/{id}Edit a book🔒 auth▸

Parameters

Name	In	Type	Description
id *	path	ULID	Book id

Request body

application/json

schema: BookInput (partial)

Responses

Code	Description	Schema
200	Updated book	Book
404	No such book	Error

DELETE/books/{id}Remove a book🔒 auth▸

Parameters

Name	In	Type	Description
id *	path	ULID	Book id

Responses

Code	Description	Schema
204	Deleted, no body	—
404	No such book	Error

OrdersCarts and purchases▾

GET/ordersList the caller's orders🔒 auth▸

Responses

Code	Description	Schema
200	A page of orders	Order[]
401	Not signed in	Error

POST/ordersPlace an order🔒 auth▸

Request body

application/json

schema: OrderInput

Responses

Code	Description	Schema
201	Order placed	Order
422	Empty or invalid cart	Error

Schemas

Credentialsobject · 2 properties▸

Property	Type	Required
email	string	required
password	string	required

Sessionobject · 3 properties▸

Property	Type	Required
token	string	required
user_id	ULID	required
expires_at	datetime	required

Bookobject · 5 properties▸

Property	Type	Required
id	ULID	required
title	string	required
author_id	ULID	required
price_cents	integer	required
isbn	string	optional

BookInputobject · 4 properties▸

Property	Type	Required
title	string	required
author_id	ULID	required
price_cents	integer	required
isbn	string	optional

OrderInputobject · 1 property▸

Property	Type	Required
items	LineItem[]	required

LineItemobject · 2 properties▸

Property	Type	Required
book_id	ULID	required
quantity	integer	required

Orderobject · 4 properties▸

Property	Type	Required
id	ULID	required
status	enum(cart,paid,shipped)	required
total_cents	integer	required
items	LineItem[]	required

Errorobject · 2 properties▸

Property	Type	Required
code	string	required
message	string	required