Freedom251 › API Documentation Tools
Miredot
What Miredot is
Miredot generates REST API documentation from existing Java source code. It connects to Maven or Gradle builds and refreshes documentation whenever a project is built. Generated files are available offline in the project’s /target or /build folder. Miredot supports annotations from JAX-RS, Spring MVC, Jackson, JAXB, RestEasy, and validation frameworks, although some support is partial. Documentation can be produced as HTML and DOCX, while the pricing table also lists RAML. Its analysis checks REST interfaces for documentation-quality issues and possible bugs; findings can warn, be ignored, or fail the build. Usage is measured by documented endpoints, defined by HTTP method, resource, and accept header, with an endpoint counted once per month. An account and organization ID are required, and projects using that ID appear on the organization dashboard. Internet access is used for licensing and dashboard quality displays, with proxy settings available. The free plan is available for non-commercial open-source projects, and paid plans start at $15 a month.
Who it suits
Miredot suits developers documenting Java APIs for people who consume those APIs. It is useful for teams building with Maven or Gradle and reviewing documentation quality during builds.
What it does well
- Generates docs from existing Java source
- Integrates with Maven and Gradle
- Offers offline generated documentation
- Checks documentation quality and possible bugs
- Free for non-commercial open source
What to know first
- Some annotation support is partial
- An account and organization ID are required
- Licensing uses an internet connection
- Additional endpoints incur usage charges
Plans
| Plan | Billed and limits | Price |
|---|---|---|
| Basic | 75 endpoints included · +$0.20 / additional endpoint · Unlimited projects · Share with 3 teammates | $15 a month |
| Pro | 175 endpoints included · +$0.15 / additional endpoint · Output customization · Word and RAML formats · Unlimited team members | $25 a month |
| Pro+ | 600 endpoints included · +$0.10 / additional endpoint · Pro features | $75 a month |
| Need More? | Contact [email protected] · Larger/fixed packs · Offline licensing · Custom invoicing · Customization | On request |
As miredot.com lists them, read 8 Oct 2026. The maker's own page has the final word.
Verdict
Miredot ties Java REST documentation to the build process and provides quality checks before release. Its free open-source offer and paid endpoint-based plans give teams different ways to use the generator.
Facts from Miredot's own pages
- Account requirement
- The reference manual says an account and organization ID are required for Miredot to work, and projects using the ID appear on the organization's dashboard. · miredot.com, 8 Oct 2026
- Build integration
- The maker says Miredot plugs into Maven or Gradle and generates updated documentation with each build. · miredot.com, 8 Oct 2026
- Code analysis
- Miredot analyzes REST interfaces for documentation quality issues and possible bugs, and can be configured to warn, ignore issues, or fail the build. · miredot.com, 8 Oct 2026
- Founded
- 2013 · miredot.com, 28 Sept 2026
- Frameworks
- Miredot supports annotations from JAX-RS, Spring MVC, Jackson, JAXB, RestEasy, and validation frameworks, with some annotation support limited or partial. · miredot.com, 8 Oct 2026
- Headquarters
- Korbeek-Lo, Belgium · miredot.com, 28 Sept 2026
- Intended audience
- Qmino describes Miredot as a tool for producing REST API documentation for developers who consume Java APIs. · miredot.com, 8 Oct 2026
- Maker and location
- The maker identifies Qmino as a Belgian software company and lists Nieuwstraat 28, BE-3360 Korbeek-Lo, Belgium. · miredot.com, 8 Oct 2026
- Offline output
- Generated documentation is available offline in the project's /target or /build folder. · miredot.com, 8 Oct 2026
- Open source offer
- The pricing page says Miredot is always free for non-commercial open source projects. · miredot.com, 8 Oct 2026
- Output formats
- The reference manual says Miredot can generate HTML and DOCX documentation; the pricing feature table also lists RAML output. · miredot.com, 8 Oct 2026
- Pricing measure
- Usage is measured by documented endpoints, defined as HTTP method plus resource plus accept header, and the same endpoint is not charged twice within a month. · miredot.com, 8 Oct 2026
- Purpose
- Miredot generates REST API documentation from existing Java source code. · miredot.com, 8 Oct 2026
- Security and licensing
- The documentation says Miredot uses the internet for licensing and for displaying documentation quality on the my.miredot dashboard; proxy settings are available. · miredot.com, 8 Oct 2026
- Support
- The pricing feature table lists next-business-day support for Pro/Pro+; the page also lists [email protected] for the open-source offer. · miredot.com, 8 Oct 2026
- Trial
- The pricing page offers a 14-day free trial of Pro features without requiring a credit card. · miredot.com, 8 Oct 2026
Where Miredot stands on Freedom251
- API Documentation Tools#15 of 27