Build API Docs with Apidog
WebSocket Documentations
Copy Page
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
WebSocket Documentations
Copy Page
Example: Coinbase
Overview
The WebSocket feed is publicly available and provides real-time market data updates for orders and trades. Two endpoints are supported in both product...
Channel
Heartbeat Channel To receive heartbeat messages for specific products every second, subscribe to the heartbeat channel. Heartbeats include sequence nu...
Previous
How to Use Apidog to Write WebSocket API Documentation
Next
Overview