Missing or incorrect server URL in OpenAPI spec
When it occurs: The Try It! button does not appear, or API consumers are unsure which base URL to use for their requests.
Why it happens: The servers section is missing from the OpenAPI spec or contains an incorrect URL. Without it, API users cannot determine where to send requests and documentation tools cannot populate the Try It! feature.
How to fix it:
- Add a correct
serverssection to your spec:
servers:
- url: https://api.yourdomain.com
description: Production
- For region-specific APIs, define multiple server entries:
servers:
- url: https://api.yourdomain.com
description: Global
- url: https://api.us.yourdomain.com
description: US region
- Ensure that all API clients (for example, Postman, cURL) use the correct server URL when making requests.
ℹ️ NOTE
The URLs above are examples. Use the actual base URL for your API.
Empty body shown in API documentation
When it occurs: An endpoint's request body displays as empty in the published documentation.
Why it happens: The OpenAPI schema is missing "type": "object" on one or more object definitions.
How to fix it: Ensure every object definition in your OpenAPI spec includes "type": "object". This attribute tells Document360 how to render request body parameters and response schemas accurately, making it easier for developers to understand and interact with your API.