API Documentation
DocStar lets you document, test and publish APIs in the same place you keep the rest of your team's docs. Each endpoint is a page in an API collection, so your API reference has the same versioning, permissions and publishing as everything else.
#
What you can do
| Task | Where to start |
|---|---|
| Document endpoints with method, URL, parameters, headers, body and sample responses | Document an API Endpoint |
| Send requests and check responses from the editor | Send and Test Requests |
| Authenticate with Basic Auth or OAuth 2.0 | Authorization |
| Read response bodies, headers, test results and logs | Responses and Cookies |
| Reuse base URLs, tokens and IDs across requests | Environments and Variables |
| Run JavaScript before and after a request, and write tests | Scripts |
| Call GraphQL APIs | GraphQL |
| Keep useful requests for later | Request History |
#
Publish an interactive API reference
When you publish an endpoint, readers see a clean reference page with the URL, parameters, headers, body fields and sample responses. They can also:
- Click TRY to send the request from the docs and see the live response.
- Copy ready-made code snippets in languages such as Shell (cURL), Node, Python, Java, Go and PHP.
- Fill in variables from a public environment that you choose to share.
See Publish Pages for how publishing works across DocStar.
#
Import and export
- Import an OpenAPI 3.x or Swagger 2.0 file (JSON or YAML), a Postman collection, or a DocStar export to create a full API collection in one step.
- Paste a cURL command into an endpoint's URL bar to fill in the method, URL, headers and body.
- Export a collection as a DocStar file or as an OpenAPI file.
Details are in Document an API Endpoint.
#
Let AI assistants use your API
Every API collection can run its own MCP server, so AI assistants such as Claude or Cursor can search your API docs and call your endpoints. See Collection MCP Server.
#
Who uses it
- Developers test and debug endpoints without leaving the docs.
- QA engineers check responses with scripted tests.
- Technical writers and product teams keep the API reference accurate and publish it to customers.
Was this helpful?