v1.0.0OpenAPI 3.0.3

Bookstore API

Endpoints: 7
Groups: 3
Models: 8

A small bookstore used as a test fixture.

Books

List books

get/books

operationId: books_list

Query parameters

pageinteger

≥ 1

Default: 1

genrestring

Values:"fiction""science""history"

Responses

array<Book>

object

curl --request GET \
  --url 'https://api.example.com/v1/books'

{
  "data": [
    {
      "title": "string",
      "genre": "fiction",
      "price": "12.50",
      "created_at": "2026-01-01T09:00:00Z",
      "id": 0,
      "author": {
        "id": 0,
        "name": "string",
        "mentor": {}
      },
      "format": {
        "size_mb": 0
      }
    }
  ],
  "meta": {
    "total": 0
  }
}

Create book

post/books

operationId: books_store

Request body

required

titlestringrequired

min length 1max length 200

genrestring

Values:"fiction""science""history"

pricestring

pattern: ^\d+\.\d{2}$

Example: "12.50"

Responses

titlestringrequired

min length 1max length 200

genrestring

Values:"fiction""science""history"

pricestring

pattern: ^\d+\.\d{2}$

Example: "12.50"

created_atstring<date-time>

idintegerrequired

Authornullable

oneOf

curl --request POST \
  --url 'https://api.example.com/v1/books' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "string",
  "genre": "fiction",
  "price": "12.50"
}'

{
  "title": "string",
  "genre": "fiction",
  "price": "12.50",
  "created_at": "2026-01-01T09:00:00Z",
  "id": 0,
  "author": {
    "id": 0,
    "name": "string",
    "mentor": {}
  },
  "format": {
    "size_mb": 0
  }
}

Get book

get/books/{id}

operationId: books_show

Path parameters

idintegerrequired

Example: 42

Responses

titlestringrequired

min length 1max length 200

genrestring

Values:"fiction""science""history"

pricestring

pattern: ^\d+\.\d{2}$

Example: "12.50"

created_atstring<date-time>

idintegerrequired

Authornullable

oneOf

curl --request GET \
  --url 'https://api.example.com/v1/books/42'

{
  "title": "string",
  "genre": "fiction",
  "price": "12.50",
  "created_at": "2026-01-01T09:00:00Z",
  "id": 0,
  "author": {
    "id": 0,
    "name": "string",
    "mentor": {}
  },
  "format": {
    "size_mb": 0
  }
}

Delete book

delete/books/{id}

operationId: books_destroy

Path parameters

idintegerrequired

Example: 42

Responses

Update book

patch/books/{id}

operationId: books_update

Path parameters

idintegerrequired

Example: 42

Request body

titlestringrequired

min length 1max length 200

genrestring

Values:"fiction""science""history"

pricestring

pattern: ^\d+\.\d{2}$

Example: "12.50"

Responses

curl --request PATCH \
  --url 'https://api.example.com/v1/books/42' \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "string",
  "genre": "fiction",
  "price": "12.50"
}'

Authors

Get author

get/authors/{id}

Path parameters

idintegerrequired

Example: 42

Responses

idintegerrequired

namestringrequired

mentorAuthor↻ circular

curl --request GET \
  --url 'https://api.example.com/v1/authors/42'

{
  "id": 0,
  "name": "string",
  "mentor": {}
}

Default

Health check

get/health

Responses

Models

Timestamps

created_atstring<date-time>

Author

idintegerrequired

namestringrequired

mentorAuthor↻ circular

BookInput

titlestringrequired

min length 1max length 200

genrestring

Values:"fiction""science""history"

pricestring

pattern: ^\d+\.\d{2}$

Example: "12.50"

Book

titlestringrequired

min length 1max length 200

genrestring

Values:"fiction""science""history"

pricestring

pattern: ^\d+\.\d{2}$

Example: "12.50"

created_atstring<date-time>

idintegerrequired

Authornullable

oneOf

Ebook

size_mbnumber

Paperback

pagesinteger

BookList

array<Book>

object

Error

array<object>