XQual API Documentation Generator

Windows package — turns a XQual CServer.java source into an OpenAPI 3.0.3 spec plus a self-hostable HTML viewer with a working Try It panel.

Latest release — v3.0.0

Download (Windows) Live preview →

Live preview renders a real openapi.json generated from a XQual CServer.java. The Try It buttons on this staging domain are wired to a development XQual backend through a server-side proxy, so you can fire actual requests and inspect real responses.

What's in the package

bin/api-doc-generator-win.exe — the generator CLI (regex + optional LLM).
output/integrated-xqual-doc.html — pre-built HTML viewer, host as-is.
samples/CServer.java — sample input.
run-doc-api-gen.bat — one-click regen + repackage helper.
README.html — full user guide (Tomcat / nginx / Apache hosting, CORS, Try-It proxy setup).

Quick start

Download and unzip the package on a Windows machine.
Open README.html for the full user guide.
Double-click run-doc-api-gen.bat to generate output\openapi.json from the bundled sample — or pass your own source: run-doc-api-gen.bat C:\path\to\CServer.java.
Upload output\xqual-api-doc-deploy.zip (HTML viewer + JSON spec) to your web server and unzip it in a public folder.
Open integrated-xqual-doc.html in a browser. To enable Try It, host it on the same origin as your XQual server, or set up the Node proxy described in the README.