OpenAPI Portal
The Talisman OpenAPI Portal is the central registry and discovery hub for your organization's REST APIs. It provides Integration Engineers and Developers with a unified catalog of all microservices that expose an openapi.json contract.
Beyond static documentation, the Portal connects to the live runtime, offering real-time observability and a built-in testing suite for interacting with your running services.
Service Catalog
The Portal automatically indexes every project in the platform that contains an OpenAPI specification. Users can browse the list of available microservices to understand their capabilities without needing to access the source code.
Schemas View
The Schemas section provides a detailed breakdown of the Data Types used by the API. This ensures consumers understand the exact structure of Request Bodies and Response Payloads.
Operations View
Drilling into a service reveals its Operations—the specific HTTP endpoints available for consumption.
- Organization: Endpoints are grouped by tags (e.g.,
Orders). - Clarity: Each operation displays its HTTP verb (GET, POST, PUT, DELETE) and a summary of its function.
Operations TryOut
Talisman features TryOut, a powerful, built-in testing interface similar to Postman. This allows engineers to validate APIs against the live environment without leaving the browser.
Expand an operation and click its TryOut button. This opens the interactive testing console for that specific endpoint.
For details on building requests and reading responses, please refer to the TryOut page.
Runtime Observability
For services that are deployed and running, the Portal overlays live execution metrics directly onto the documentation.
- Traffic Stats: Each operation shows three counts: messages processed, in flight, and failed.
- Health Check: Spot operations with failed or in-flight messages at a glance.