A Gradle plugin that auto-generates REST API documentation by scanning Spring Boot @RestController classes and their Javadoc comments.
Version: 2.0.6 Requirements: Java 17+, Gradle 7.0+, Spring Boot Repository: https://github.com/Axim-one/gradle-restdoc-generator
| documentPath | Yes | — | Output directory (relative to project root) | | basePackage | Yes | — | Package(s) to scan (comma-separated for multiple) | | serviceId | Yes | — | Service unique ID (used as JSON filename) | | serviceName | No | "" | Display name (OpenAPI title) | | apiServerUrl | No | "" | API base URL (OpenAPI servers) |
Auto-generate REST API documentation from Spring Boot controllers using the Axim Gradle RestDoc Generator plugin. Use when configuring restMetaGenerator DSL, writing Javadoc tags (@response, @group, @auth, @error, @header), generating OpenAPI 3.0.3 specs, spec-bundle.json, error code scanning, Postman sync, or troubleshooting the gradle-restdoc-generator plugin. Source: axim-one/gradle-restdoc-generator.