Flyte API Playground: Swagger¶
Flyte services expose gRPC services for efficient/low latency communication across all services as well as for external clients (FlyteCTL, FlyteConsole, Flytekit Remote, etc.).
The service definitions are defined here. FlyteIDL also houses open API schema definitions for the exposed services:
For convenience, Flyte deployments also ship with a redocly/redoc image container to expose swagger UI. By default, it is only deployed in sandbox deployments.
To view the UI, run the following command:
flytectl sandbox start
Once sandbox setup is complete, a ready-to-explore message is shown:
👨💻 Flyte is ready! Flyte UI is available at http://localhost:30081/console 🚀 🚀 🎉
Visit http://localhost:30081/openapi to view swagger UI for the service and documentation of the payload fields. To test, send sample queries!