LinkShift API documentation hub: endpoint pages, schema trees, and Try me
New API documentation in LinkShift now includes endpoint-level pages, expandable request/response schemas, and interactive requests.
Quick comparison
| Area | LinkShift | Scattered API notes across tools |
|---|---|---|
| Endpoint discoverability | Tag-grouped sidebar + dedicated page per endpoint | Mixed docs or static snippets without endpoint pages |
| Schema readability | Expandable tree with types, nullable/default, and constraints | Flat JSON examples without structure metadata |
| Request execution | Try me with API key and URL persisted in session | No in-doc execution or external-only clients |
| Source of truth | OpenAPI 3.1 drives endpoint details and schemas | Manual docs updates prone to drift |
| Operational docs | Backend markdown guides integrated in docs section | Separate and disconnected engineering notes |
What is included in the new docs hub
LinkShift now ships a dedicated documentation section under /docs with endpoint pages generated from OpenAPI definitions.
Each endpoint page includes operation metadata, parameter details, security requirements, request body schema, response schemas, and interactive execution.
Why OpenAPI as source of truth matters
When endpoint pages are generated from OpenAPI, new endpoints and schema updates appear in docs without manual rewrites of every section.
That reduces divergence risk between implementation and documentation, especially for request and response payload contracts.
- Tag groups and endpoint pages come directly from OpenAPI paths and operationIds
- Request and response schema trees are resolved from references at runtime
- Try me defaults are inferred from schema examples/defaults when possible
Try me workflow in practice
Try me uses browser fetch and supports base URL plus API key persistence in session storage, so values survive docs navigation in one browser session.
Query payloads are serialized with qs-compatible formatting and request bodies are sent as JSON when schema indicates content.
Maintenance model
Documentation includes a sync command that ingests backend markdown guides and OpenAPI endpoint snapshots.
This gives teams a repeatable workflow when API contracts evolve and new docs sections need to be refreshed.
When the competitor may be a better choice
- When your team only needs a minimal endpoint list and does not need schema exploration.
- When API testing must happen exclusively in external tooling due to strict browser policies.
Sources
Want to test these scenarios on your own domain?
In LinkShift, you connect a domain and get HTTPS, hierarchical rules, and link maps for large-scale key mapping.