Weave Code
Jasper Rest Client Laravel Package
sigedi/jasper-rest-client
Lightweight PHP/Laravel client for the JasperReports Server REST API. Run reports, pass parameters, select export formats such as PDF, XLSX, and CSV, and handle authentication through a simple, framework-friendly interface. A convenient way to embed JasperReports output in your Laravel applications.
A client for the JasperReports Server REST API
Frequently asked questions about Jasper Rest Client
- How do I install sigedi/jasper-rest-client in a Laravel project?
- Install it with composer require sigedi/jasper-rest-client. It is a framework-agnostic PHP wrapper, so Laravel will not auto-register anything for you. Create your own service provider or binding and inject the client where needed.
- Does sigedi/jasper-rest-client support Laravel 11 and Laravel 12?
- Version 2.0.0 adds Symfony 7 support, which aligns with Laravel 11 and 12 dependency trees. If your application is on Laravel 10 or earlier with Symfony 6 components, check the composer.json constraints before installing, because the release may have dropped the older Symfony range. There is no official Laravel version support statement.
- Does this package include a Laravel service provider, facade, or config file?
- No. The package is intentionally thin and does not ship a Laravel service provider, facade, or config file. You configure the JasperReports Server URL and credentials yourself, then wrap the client behind an interface such as a ReportGenerator to keep it out of controllers and jobs.
- How do I run a Jasper report and export it as PDF with this client?
- Use the client to look up the report resource on JasperReports Server, execute it, and request the desired output format. The package translates those calls into JRS REST requests for resource lookup, execution, export, and retrieval. A common pattern is to wrap this in an internal service method that returns the exported file contents or a stored path.
- Can I pass parameters to a JasperReports report with sigedi/jasper-rest-client?
- Yes. Report execution accepts parameters that are passed through to JasperReports Server when the report is run. Keep parameter names and types aligned with the report design, and test against a live JRS instance because the package does not validate them for you.
- Which export formats are supported for JasperReports output?
- The package supports exporting report output to PDF, XLSX, CSV, and other formats exposed by the JasperReports Server REST API. The exact format identifiers depend on the JRS endpoint and your server version. Verify the format you need during a smoke test rather than assuming every JRS export type is wrapped.
- How do I configure the JasperReports Server URL and credentials?
- Configuration is limited to the JasperReports Server base URL and the credentials used for authentication. You supply these values in your own Laravel config or environment variables and pass them to the client. The package does not publish a config file, so credential handling and secret storage remain your responsibility.
- What changed in version 2.0.0 and is it a breaking upgrade from 1.0.0?
- 2.0.0 is a major version bump, so treat it as potentially breaking. The changelog names an encoding fix, Symfony 7 support, and code quality improvements, and the last item could include public signature or type changes. Review the diff from 1.0.0 to 2.0.0 and test your integration before upgrading. The encoding fix may also change exported bytes for non-ASCII content, so remove any old mojibake workarounds.
- What license does sigedi/jasper-rest-client use and can I use it commercially?
- It is licensed under LGPL-3.0, so commercial use is possible but needs a legal opinion, especially if you modify, redistribute, or bundle it into a distributed appliance. Nothing in 2.0.0 changes the licensing position. Get the approval on record before shipping.
- Is sigedi/jasper-rest-client actively maintained and safe for production use?
- Treat it as a thin adapter rather than a fully managed integration. Version 2.0.0 has one reviewed external contribution, but there is still no CI badge, published test count, or release cadence, so bus factor remains effectively one. There is also no documented guidance on streaming, timeouts, polling, or large exports, so you should load-test against your JRS and add your own timeout and retry handling.
Weaver
How can I help you explore Laravel packages today?