Exploring the New OpenAPI-Compliant REST API v3 in Infinispan 16.1
Exploring the New OpenAPI-Compliant REST API v3 in Infinispan 16.1
With Infinispan 16.1 "Polly Want a Pilsner", we introduce the OpenAPI-compliant v3 REST API, bringing modern API standards to Infinispan.
The Evolution
Infinispan now embraces OpenAPI standards with the new v3 REST API, enabling better tooling, documentation, and developer experience through standardized API descriptions.
What’s New in v3?
-
Full OpenAPI 3.0 compliance
-
Interactive Swagger UI at
/swagger-ui -
Improved endpoint organization and type safety
Getting Started
Start an Infinispan Server 16.1+ and visit http://127.0.0.1:11222/swagger-ui/ to explore and test the API. The OpenAPI schema is available at http://127.0.0.1:11222/rest/v3/openapi.
OpenAPI Benefits
A standardized, rich API description like OpenAPI brings numerous advantages for developers:
-
Enhanced Documentation: Interactive, always-up-to-date API docs via Swagger UI
-
Automated Tooling: Generate client libraries in multiple languages automatically
-
Improved Testing: Built-in API testing interfaces
-
Polyglot Support: OpenAPI works across programming languages, enabling seamless integration regardless of your tech stack
-
AI-Assisted Development: AI code assistants can generate accurate client code from the OpenAPI spec, reducing development time and errors
Check out our demo at https://github.com/rigazilla/infinispan-sqlstore-demo/tree/openapi-demo, which demonstrates a live coding session where AI code assistants generate accurate Infinispan client code from the OpenAPI spec, showcasing rapid development and error reduction.
Conclusion
The v3 API brings modern API standards to Infinispan, enhancing developer productivity. Download 16.1, try the new OpenAPI v3 REST interface, and let us know your feedback!
For details, see REST API docs.
Get it, Use it, Ask us!
We’re hard at work on new features, improvements and fixes, so watch this space for more announcements!Please, download and test the latest release.
The source code is hosted on GitHub. If you need to report a bug or request a new feature, look for a similar one on our GitHub issues tracker. If you don’t find any, create a new issue.
If you have questions, are experiencing a bug or want advice on using Infinispan, you can use GitHub discussions. We will do our best to answer you as soon as we can.
The Infinispan community uses Zulip for real-time communications. Join us using either a web-browser or a dedicated application on the Infinispan chat.
Vittorio Rigamonti
Software developer who codes ranging from embedded to cloud. He can do bugs in several programming languages. Loves maths, open source code and cooking.
