Build API Docs with Apidog
    Build API Docs with Apidog
    • Overview
    • REST API Documentations
      • Basics
        • API-Design First Approach
        • Specify an endpoint
        • Components
        • Common parameters
        • Global parameters
        • Schemas
          • Overview
          • Create a new schema
          • Build a schema
          • Generate Schemas from JSON etc.
      • Advanced features
        • Custom endpoint fields
        • Endpoint status
        • Appearance of parameter lists
        • Endpoint unique idenfication
      • Example: Pet Store
        • Get user info
        • Find pet by ID
        • Add a new pet to the store
        • Update an existing pet
        • Deletes a pet
        • Finds Pets by status
    • SOAP API Documentations
      • How to Use Apidog to Write SOAP API Documentation
      • Example: WebService
        • WebService: Number To Words
        • SOAP: Add integers
        • SOAP/WSDL: Ebay
      • Example: Mastercard
        • Purchase Request
        • Submit a purchase request
    • GraphQL Documentation
      • How to Write GraphQL API Documentation Using Apidog
      • Example: Github
        • Introduction to GraphQL
        • Queries
        • Public schema
    • WebSocket Documentations
      • How to Use Apidog to Write WebSocket API Documentation
      • Example: Coinbase
        • Overview
        • Channel
    • SSE API Documentations
      • Example: Anthropic
        • Streaming Messages
        • Messages
    • gRPC API Documentations
      • How to Use Apidog for gRPC API Documentation and Testing
      • Example: Proto Documentation
        • Protocol Documentation

    Build API Docs with Apidog

    Apidog supports writing documentation for almost all types of APIs, including REST, SOAP, GraphQL, gRPC, WebSocket, SSE, and more.
    Explore our collection of documentation best practices and real-world API examples.

    API Technologies#

    REST API Documentation#

    API-Design First Approach
    Specify an endpoint
    Example Pet Store API

    SOAP API Documentation#

    How to Use Apidog to Write SOAP API Documentation
    ExampleWebService APIs
    ExampleMastercard API

    GraphQL API Documentation#

    How to Write GraphQL API Documentation Using Apidog
    Example Github API

    gRPC API Documentation#

    How to Use Apidog for gRPC
    Example Protocol Documentation

    WebSocket API Documentation#

    How to Use Apidog to Write WebSocket API Documentation
    Example Coinbase API

    SSE Documentation#

    Example Anthropic API

    Publishing Documentations#

    Publish API Docs#

    Create impactful API documentations in one click. Learn more
    Generate API doc
    Mix Markdown with API
    Custom nav & domain

    Apidog Markdown#

    Apidog Markdown adds elegant components and styles to native Markdown syntax. Learn more
    Introduction
    Basic syntax
    Components
    Modified at 2025-03-27 06:19:46
    Next
    API-Design First Approach
    Built with