SapanBaseDevelopers

How readers use your API reference (operations, code samples, deep links)

What a published API reference looks like to readers: tag-grouped navigation, code samples, and deep links to a specific operation.

Once published, your API reference gives readers a navigable, code-sample-rich way to explore your API.

Navigation

Operations are grouped by tag in the sidebar, mirroring the structure of your OpenAPI spec.

Code samples

Every operation includes ready-to-use code samples — a cURL command and a JavaScript fetch call — generated automatically from the spec, so readers can copy-paste a working request rather than building one from scratch.

Every operation has its own URL, anchored to its operationId — so you can link directly to a specific endpoint from anywhere, rather than sending someone to the top of the reference and asking them to scroll.