OpenAPI Client Generation

Studio provides tools to simplify integration of Jmix applications with external REST services. It allows you to:

  • Generate client code from an OpenAPI schema of the external service.

  • Generate Jmix entities and mappers to and from imported OpenAPI model classes.

  • Create application-level services that work with Jmix entities, convert them to external model classes and invoke the imported API endpoint classes.

This creates a convenient abstraction layer of Jmix entities and Spring services. The application UI and business logic can interact with external data without directly using low-level model and API classes imported from the OpenAPI schema.

openapi client.drawio
Figure 1. Integration with external REST service

To start importing OpenAPI schema and generating client code, select New (+) → Advanced → OpenAPI Client in the Jmix tool window.

See the Integrating Applications Using OpenAPI guide for detailed instructions.

This feature is free to use in small projects with up to 10 entities and roles. In a larger project, it requires a Sprint, Enterprise, or BPM subscription.