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
    • Schemas
      • Sample Schemas
        • Pet
        • Category
        • Tag
      • 公共模型
        • 关联字段枚举值
        • 公共返回 Response
      • 枚举
        • UserStatus
      • Stream request
      • User

    User

    {
    "username": "string",
    "description": "string",
    "avatar": "string"
}
    Built with