Skip to navigation
Getting Started

Introduction

A simple REST API for managing a library of books.

The SmartX Books API lets you create, read, update, and delete books in a library. It’s a standard CRUD API with no authentication required — great for exploring how Fern generates documentation from an OpenAPI spec.

Base URL

http://localhost:3000

Resources

The API exposes one resource:

ResourcePath prefixDescription
Books/api/v1/booksManage individual book records

Operations

MethodPathWhat it does
GET/api/v1/booksList all books
POST/api/v1/booksCreate a new book
GET/api/v1/books/{id}Fetch a book by ID
PUT/api/v1/books/{id}Update a book
DELETE/api/v1/books/{id}Delete a book
GET/healthService health check

Authentication

This API requires no authentication. All endpoints are publicly accessible.

Request & response format

All request and response bodies use application/json.

A Book object looks like this:

{
  "id": "1",
  "title": "The Great Gatsby",
  "author": "F. Scott Fitzgerald",
  "year": 1925
}

Error responses

Errors follow a consistent shape across all endpoints:

{
  "error": {
    "name": "NotFound",
    "message": "Book with id '99' was not found."
  }
}

Next steps

Browse the full endpoint reference in the API Reference tab.