Document360's API documentation feature gives you a complete, end-to-end solution for publishing, managing, and testing API references. Whether you're a startup shipping your first public API or an enterprise maintaining dozens of internal microservices, Document360 turns your OpenAPI specification into polished, interactive developer documentation without requiring any custom tooling or manual formatting.
What is API documentation and why does it matter?
API documentation is the technical reference that tells developers exactly how to interact with your API: which endpoints exist, what parameters they accept, what responses they return, and how authentication works. Unlike general knowledge base articles, API docs follow a strict, structured format derived from a machine-readable specification file.
Why it matters:
- Reduces integration time. Clear docs cut onboarding from days to hours. Developers spend less time guessing and more time building.
- Reduces support burden. When docs answer the "how do I authenticate?" and "what does a 422 mean?" questions, your team fields fewer tickets.
- Builds developer trust. Incomplete or outdated API docs signal an unreliable product. High-quality documentation is a direct signal of product quality.
- Enables self-service. External partners, customers, and third-party developers can integrate without needing hand-holding from your team.
API documentation vs regular documentation
| Aspect | API documentation | Regular documentation |
|---|---|---|
| Primary audience | Developers and technical integrators | End users, internal teams |
| Structure | Driven by a specification file (OpenAPI, Postman) | Manually authored articles |
| Content type | Endpoints, parameters, schemas, auth methods | Guides, how-tos, conceptual articles |
| Interactivity | Live testing via Try It! | Static reading |
| Versioning | Tied to API spec versions | Managed editorially |
| Auto-generation | Yes, from spec file | No |
In Document360, API documentation lives in a dedicated API workspace that is separate from your standard knowledge base. This allows different access controls, routing, and branding for your developer-facing content. For a full reference of all available endpoints and schemas, see the Document360 developer docs.
Supported specification formats
Document360 supports the following specification formats:
- OpenAPI 2.0 (formerly Swagger)
- OpenAPI 3.0
- OpenAPI 3.1 (includes webhook support)
- Postman Collections
Files can be uploaded as JSON, YAML, or YML.
If you're starting fresh, use OpenAPI 3.1. It's the current standard, supports webhooks natively, and has the richest tooling ecosystem. If you're migrating from an existing Swagger 2.0 setup, Document360 accepts it as-is while you upgrade incrementally.
The Try It! feature in Document360 allows you to test API endpoints directly on the Knowledge base site. The interactive console enables developers to input the necessary parameters and execute API calls, getting real-time responses, without leaving the documentation or writing any code.
The Try It! section supports multiple security schemes simultaneously, enabling users to test endpoints that require combined authentication methods more effectively.
Webhooks in OpenAPI 3.1
Document360 supports webhooks defined in OpenAPI 3.1. Webhooks appear with an event icon in your API reference and include a payload section based on your schema. If no example is provided, Document360 shows a default example and a sample payload. Try It! is not available for webhooks. Webhooks are supported for file uploads, URL imports, and CI/CD flows.
Authorization techniques
When interacting with an API, it is important to ensure that only authorized users can access certain data or perform specific actions. Document360 supports the following authorization methods:
- Basic authentication - Requires a username and password passed in the request.
- Bearer token - Authenticates with a token generated after login.
- API key - Uses a unique key, passed in the request headers, for authentication.
- OAuth2 - Secures APIs through various flows: Authorization Code, PKCE, Client Credentials, and Implicit.
- OpenID Connect - Extends OAuth2 by adding user identity verification.
To authenticate requests to the Document360 Customer API, you will need an API token. For more information, see the API tokens article.
To make your first authenticated API request using Swagger, Postman, or curl, refer Making your first request.
OAuth2 and OpenID Connect: additional configuration
When working with APIs that use OAuth2 or OpenID Connect, two settings are required for Try It! to work correctly:
- Redirect URI - Set this in your OAuth provider to the format
domain/oauth. For example:https://apidocs.document360.com/oauth. - Silent renewal - Document360 automatically refreshes the authorization token in the background during active Try It! sessions, so users do not need to re-authenticate manually.
FAQ
How is API documentation different from regular documentation?
API documentation is specifically designed to explain endpoints, authentication, and integrations. It is separate from your standard knowledge base articles and useful for developer-facing content.
What is an API reference?
An API reference is a documentation resource that provides comprehensive information about the functions, classes, methods, parameters, return types, and other components of an API. It is a guide or manual for developers who want to integrate or use the API in their applications.
What are the supported specification file formats?
You can upload your specification file as a URL, JSON, YAML, or YML file. Document360 supports OpenAPI 2.0, OpenAPI 3.0, OpenAPI 3.1, and Postman API specifications.
How many API references can I create?
Within each API workspace, you can create a maximum of 3 API references.
What is the default ordering of categories when uploading an OpenAPI specification file?
Categories in Document360 are created based on the tag order defined in your spec file. For example, if your spec defines tags in the order Pet, Store, User — the categories will appear in that same order.
The "Try It!" option is not available on the Knowledge base site. What could be the reason?
If the Try It! feature isn't visible, ensure that both the server variable and the server URL are properly defined in your API specification file. Without these, the feature will not function.
Can API reference dropdown values be modified through the UI?
No. Changes to API reference elements such as dropdown values can only be made through the OpenAPI specification file. Modifying these values through the UI is not currently supported.