This tutorial outlines how to dynamically generate API documentation using Quarkus, LangChain4j, the Qwen model from Ollama, and Quarkus’s OpenAPI output. In development mode, documentation is generated on-the-fly, enhancing productivity. First, scaffold a Quarkus app, integrating Ollama, then set up the configuration to point to the Qwen model. With application properties configured, create a Product
class with necessary OpenAPI annotations and a ProductResource
class for REST endpoints, allowing product management. The generated OpenAPI spec can be accessed at /q/openapi
. Next, define the OpenApiDocGenerator
interface to generate Markdown documentation using LangChain4j, binding it to the Ollama model. Finally, create a DocumentationResource
class that retrieves the OpenAPI spec, calls the AI service, and returns the documentation. The completed application offers a simple HTML page that renders the Markdown documentation, ensuring a user-friendly interface and a streamlined documentation development process with LLM capabilities.
Creating AI-Driven API Documentation with Quarkus, LangChain4j, and Ollama

Leave a Comment
Leave a Comment