API Documentation Strategy
Document 6 API types in one platform: REST (OpenAPI 3.1), GraphQL, AsyncAPI (18 protocols), Webhooks (7 verification methods), MCP servers, and gRPC. Live schema references stay synchronised as definitions change.
API Documentation That Stays Synchronised
API documentation requires more than endpoint lists. It requires security schemes, request and response examples, schema references, error handling, and versioning strategy. Dedicated editors for 6 API types cover REST, GraphQL, AsyncAPI (18 protocols including Kafka, AMQP, MQTT), Webhooks (7 verification methods), MCP servers (for AI agent integration), and gRPC, with live schema references that stay synchronised as definitions change.
REST API Documentation
GraphQL API Documentation
Document GraphQL APIs with operation definitions for queries, mutations, and subscriptions. Define types, directives, and custom scalar types. GraphQL documentation lives alongside REST documentation in the same workspace.
Security Scheme Configuration
API Documentation in the Published Site
Common Questions
Document data architecture with a model-first workflow: define entities in the central data model, create data views with database profiles, build schemas with model-property lineage, document 6 API types (REST, GraphQL, AsyncAPI, Webhooks, MCP, gRPC), and generate 16 governance reports with PDF export.
Document REST APIs with full endpoint specifications, OpenAPI import and export, seven HTTP methods, parameters, request and response bodies linked to shared schemas, authentication schemes, and a published API browser. REST is one of six API types (REST, GraphQL, gRPC, AsyncAPI, Webhooks, MCP) sharing a unified schema layer.
Architecture documentation that stays current because it lives in Git alongside code, updates in pull requests, and publishes automatically when changes merge.