View API documentation in a test environment

Documentation becomes visible once an API is deployed to an approved test space.

Before you start

You need an account with the appropriate access before you can view the published documentation.

Create a test application

Set up a test application. Application setup and subscription will depend on the API access model.

Check the documentation is viewable

1. Visit API documentation.
2. Search for the API.
3. Open its entry.
4. View endpoints and the rendered specification.

What to confirm

• Discoverability in search and navigation.
• Correct access behavior.
• Content accuracy and clarity.
• Clear endpoint rendering.

Need support?

If you are blocked, ask for help through your normal support route.

Got feedback?

Share feedback to help improve this guidance.