Live Examples

API Documentation
Examples

Explore real-world API documentation examples generated with APIDocly. Each example showcases different use cases and annotation patterns.

Pro tip: Download the OpenAPI JSON and feed it to AI assistants for instant API integration code!
@apiSuccessExample & @apiErrorExample

E-Commerce API

Complete REST API for online stores with products, cart, orders, and payments.

Detailed response examples with real JSON payloads

RESTProductsPayments
@apiPermission

User Management API

Authentication, authorization, roles and user profile management endpoints.

Role-based access control (admin, superadmin, owner)

AuthJWTRBAC
@apiDeprecated

Social Media API

Posts, comments, likes, followers and messaging system API documentation.

Deprecated endpoints with migration guidance

SocialFeedMessaging
File Uploads & Binary

File Storage API

Upload, download, manage files and folders with sharing capabilities.

Multipart uploads, binary responses, streaming

FilesUploadCloud
@apiQuery & Filtering

Analytics API

Track events, generate reports and visualize data with flexible queries.

Complex query parameters and aggregations

EventsReportsCharts
WebSocket & Templates

Notifications API

Push notifications, email templates and real-time messaging endpoints.

Real-time events and template syntax examples

PushEmailWebSocket
@apiPrivate

Payment Gateway API

Process payments, manage subscriptions and handle refunds securely.

Internal/private endpoints for backend-only use

StripeWebhooksBilling
@apiVersion

Booking System API

Appointments, reservations, availability and calendar management.

API versioning (v1.0.0 vs v1.1.0 comparison)

CalendarScheduleSlots
Nested Objects

Inventory Management API

Stock tracking, warehouse management and supply chain endpoints.

Complex nested request/response structures

StockWarehouseSKU
@apiHeader & Custom

Content Management API

Manage articles, pages, media and content workflows programmatically.

Custom headers and content-type handling

ContentMediaWorkflow
GeoJSON Responses

Geolocation API

Location-based services, maps integration and address lookup.

Spatial data with coordinates and polygons

MapsGeocodingGPS
WebSocket Streaming

IoT Device API

Device management, telemetry data and remote control endpoints.

Real-time telemetry and device commands

DevicesTelemetryMQTT
AI-Ready Documentation

Export OpenAPI JSON for
Instant AI Integration

Every APIDocly documentation includes an OpenAPI 3.0 JSON export. Download it and feed it to ChatGPT, Claude, or any AI assistant to:

  • Generate API client code in any language
  • Create TypeScript/Zod models from schemas
  • Build ready-to-use integration modules
  • Understand complex API relationships quickly
openapi.json
{
  "openapi": "3.0.0",
  "info": {
    "title": "My API",
    "version": "1.0.0"
  },
  "paths": {
    "/users": {
      "get": {
        "summary": "List users",
        "responses": { ... }
      }
    }
  }
}

Ready to create your own?

Generate beautiful API documentation from your source code in seconds.