liferay-rest-builder

What problem does it solve?

Liferay REST Builder eliminates the repetitive and error-prone work of hand-coding REST and GraphQL endpoints by generating API interfaces, DTOs, JAX-RS applications, and scaffolding that you implement in ResourceImpl classes, enabling faster, consistent headless API delivery.

Core Features & Use Cases

• Code generation from OpenAPI: Produce headless-api interfaces, DTO classes, and implementation scaffolding from a rest-openapi.yaml specification.
• Simultaneous REST and GraphQL output: Generate both JAX-RS resources and GraphQL endpoints from the same schema to keep APIs consistent.
• Implementation best-practice enforcement: Directs business logic into ResourceImpl classes and prevents editing regenerated Base* files to avoid regressions.
• Use Case: Scaffold a Foo entity with paginated GET, POST, PUT, and DELETE endpoints, implement persistence in FooResourceImpl, and deploy the module to Liferay.

Quick Start

Run the REST Builder buildREST task in the implementation module to generate headless-api and headless-impl scaffolding and then implement your business logic inside the generated ResourceImpl classes.