Testing API with Mock server

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude
• Connect to Cursor

  Install MCP server on Cursor
• Connect to VS Code

  Install MCP server on VS Code

This guide explains how to use built-in Try It feature to test API endpoints during development.

1. Open the API Documentation

Navigate to the API documentation for your project.

2. Select the Mock Server

1. In the Server dropdown (top right of the API docs), select the Mock Server option.
   This allows you to test endpoints without calling the live backend.

Note: The mock server returns example responses defined in your OpenAPI specification.

3. Configure Security Settings

1. In the Security panel (top right), choose Authorization type:
   • Select JWT from the dropdown.
2. In the Bearer Token field, enter any placeholder value.
   • For mock server testing, the token is not validated, so you can type anything (e.g., test-token).

4. Send a Test Request

1. Open any endpoint in the documentation.
2. Fill in any required parameters or request body fields.
3. Click Try It.
4. Review the mock server’s simulated response.

5. Switching Back to Live API

When ready to test against the live backend:

1. Change the Server selection from Mock Server to your production or staging server URL.
2. Provide a real JWT token obtained from the authentication process.

Example Screenshot