Yearly Pay yearly and get 2 months free on every paid plan. See plans
Sign in Start free

REST API designer

Input
Domain description
a library management API: books, members, loans, reservations
Sample output Made on 27 October 2026

Library Management REST API

Base URL:

https://api.example.com/v1

All request and response bodies use application/json. Dates use ISO 8601 in UTC. Resource IDs are UUIDs.

Endpoint Table

Books

Method Path Purpose Status Codes
GET /books List and filter books 200, 400
POST /books Create a book record 201, 400, 409, 422
GET /books/{bookId} Retrieve a book 200, 404
PATCH /books/{bookId} Update book metadata or inventory 200, 400, 404, 409, 422
DELETE /books/{bookId} Delete or archive a book 204, 404, 409
GET /books/{bookId}/availability Retrieve copy and reservation availability 200, 404

Members

Method Path Purpose Status Codes
GET /members List and filter members 200, 400
POST /members Register a member 201, 400, 409, 422
GET /members/{memberId} Retrieve a member 200, 404
PATCH /members/{memberId} Update member details or status 200, 400, 404, 409, 422
DELETE /members/{memberId} Archive a member with no active obligations 204, 404, 409
GET /members/{memberId}/loans List a member’s loans 200, 400, 404
GET /members/{memberId}/reservations List a member’s reservations 200, 400, 404

Loans

Method Path Purpose Status Codes
GET /loans List and filter loans 200, 400
POST /loans Check out one or more books to a member 201, 400, 404, 409, 422
GET /loans/{loanId} Retrieve a loan 200, 404
POST /loans/{loanId}/renewals Renew an active loan 200, 400, 404, 409, 422
POST /loans/{loanId}/return Return a borrowed copy 200, 400, 404, 409

Reservations

Method Path Purpose Status Codes
Use this REST API designer The form opens filled with this sample's inputs; change anything.