Petstore

Welcome to the Petstore API Documentation Template! This is a starting point for creating clear, interactive, and user-friendly API documentation.

Use this template to explore best practices in structuring your docs, showcasing endpoints, and guiding users through your API. Everything here can be adapted to fit your own product.

Why this demo? This template shows automatically generated docs from an OpenAPI spec. It uses Gitbook-specific Open API extensions to create a rich, interactive experience.

Production

Base URL https://petstore.example.com/v1

Staging

Base URL https://staging.petstore.example.com/v1

Getting Started

1

Create an account

Sign up for a free account at petstore.example.com.

2

Get your API key

Sign in to the Petstore console and copy your key.

3

Make your first request

Call the GET /pets endpoint to check connectivity.

Learn more

Documentation

Everything you need to know about the product

Changelog

See what’s new and improved

Community

Connect with other users and contributors

This API is for demo purposes only — don’t use it in production.