Preview & Try It Out
Interactive Documentation
The Preview provides Swagger UI-style interactive documentation. Browse your API, see all endpoints, and test requests directly - without leaving Tigrister.
Access Preview
In Designer mode, click "Split" to see Preview alongside the editor, or "Preview" for a full-width documentation view.
API Info Header
The top of Preview shows your API's key information:
A sample API that uses a petstore as an example to demonstrate features.
Server & Environment Selection
Choose which server to send requests to and which environment variables to use:
Server Validation
Try It Out requires a valid server URL starting with http:// or https://. Template variables like {host} must be resolved first.
Endpoints by Tag
Endpoints are grouped by their tags (modules). Click to expand and see operations:
Try It Out
Test any endpoint directly from the Preview. Click an operation to expand it, then click "Try it out" to enable editing:
Expand an Operation
Click on any endpoint row to expand its details.
Click "Try it out"
This enables parameter inputs and the request body editor.
Fill in Parameters
Enter values for path, query, header, and cookie parameters.
Click "Execute"
Send the request and see the response below.
Parameters
| Name | Description |
|---|---|
petId integer (path) | ID of pet to return |
Authorization
Click the "Authorize" button to provide credentials for protected endpoints:
Lock Icons
Auth Methods
- API Key (header, query, cookie)
- HTTP Basic / Bearer
- OAuth 2.0 flows
- OpenID Connect
Endpoint-Specific Auth
Click a lock icon on an individual endpoint to authorize just for that operation. This is useful when different endpoints use different auth schemes.
Execution Results
After executing a request, the response is displayed below the Execute button:
{
"id": 123,
"name": "Buddy",
"status": "available",
"photoUrls": [
"https://example.com/photo1.jpg"
]
}OAuth2 Authorization Flow
When your API uses OAuth2, here's the step-by-step flow in Preview:
Click "Authorize" Button
Opens the authorization modal showing all defined security schemes.
Select OAuth2 Scheme
Enter client_id, client_secret (if applicable), and select scopes.
Click "Authorize"
For Authorization Code flow, a popup opens to the provider's login page.
Complete Login
Log in and grant permissions. Tigrister receives the access token automatically.
Execute Requests
Token is automatically included in Authorization header. Lock icons show as "closed".
PKCE Support
For public clients, Tigrister automatically uses PKCE (Proof Key for Code Exchange) to enhance security during the Authorization Code flow.
Editing Complex Request Bodies
For POST/PUT/PATCH operations with request bodies:
JSON Body Editor
Edit the request body as JSON with syntax highlighting.
Example Dropdown
If the spec has examples, select them from a dropdown.
Schema-Guided Editing
The editor shows the expected schema structure. Required fields are marked, and enum values show as autocomplete suggestions. Invalid JSON is highlighted in red.
Advanced Try It Out Features
Tigrister's Try It Out includes several advanced features for a seamless testing experience:
Token Auto-Refresh
OAuth2 and OpenID Connect tokens are automatically refreshed before they expire. No manual re-authorization needed for long sessions.
Environment Variables
Use {{VAR}} syntax in parameter values. Variables are replaced from your active environment before sending.
Parameter Validation
Required parameters are validated before execution. Missing or invalid values are highlighted with clear error messages.
Array Parameters
Array-type parameters get a special multi-value input. Add/remove values easily, with enum options shown as checkboxes.
Parameter Inheritance
Path-level parameters are inherited by all operations. Operation parameters override path-level ones with the same name.
Content-Type Selection
When multiple content types are defined (JSON, XML, form-data), choose which format to send via dropdown.
Smart Example Generation
Tigrister generates realistic example values based on schema format:
| Format | Generated Example |
|---|---|
| date-time | 2024-01-15T10:30:00Z |
| date | 2024-01-15 |
| user@example.com | |
| uri / url | https://example.com |
| uuid | 550e8400-e29b-41d4-a716-446655440000 |
| enum | First enum value |
Circular Reference Handling
Self-referential schemas (like tree nodes) are detected and show "..." to prevent infinite loops in example generation.
cURL Export
After executing a request, you can copy it as a cURL command for use in terminal:
curl -X 'GET' \ 'https://api.petstore.com/pet/123' \ -H 'accept: application/json' \ -H 'Authorization: Bearer eyJhbG...'
When to Use cURL Export
- - Debugging from terminal
- - Sharing exact request with teammates
- - Adding to documentation
What's Included
- - Full URL with query params
- - All headers including auth
- - Request body (for POST/PUT)
Schemas Preview
At the bottom of Preview, all defined schemas are displayed with expandable details: