Publish documentation for your own API

Cloudgate's Document Builder lets you describe the APIs and workflows you provide to your users. Organize it around their tasks and keep examples aligned with the released API contract.

Plan the structure#

Open Workflows → Document Builder. Start with a short overview, access requirements, a working first request, and a reference for each public operation.

Group related operations into chapters and use descriptive page titles. Keep setup instructions separate from detailed field reference so a new reader can reach a successful request quickly.

Write an operation page#

Include:

• What the operation does and who may call it.
• Environment, method, and route.
• Required headers, route/query values, and body fields.
• A minimal request and its actual response shape.
• Validation, denied-access, and missing-record behavior.
• Side effects, retry considerations, and relevant limits.

Use the builder's available text, code, callout, image, and request/example controls for a clear written explanation. Explain the steps in text so the reader can follow them without a recording.

Configure examples carefully#

Use placeholders for credentials and synthetic records. If you add an interactive request widget, identify its environment and whether it can change data. Prefer harmless read examples for an unaffiliated reader's first request.

A saved example should be verified against the intended release. Keep create/update request fields distinct from list/detail response fields.

Brand and preview#

Configure the documentation name, branding, and top navigation links. Preview chapter navigation, code formatting, long tables, and narrow-screen layout. Check that every link leads to a real page and that copied requests work with the documented setup.

Maintain the contract#

Update the relevant page when changing a public route, field, authentication requirement, or error response. Record compatibility notes for existing clients, and give readers a clear support path.

See Postman collections for shareable requests and release review for coordinating documentation with publication.