Loading... Loading ...
expand / collapse all

Welcome to the MireDot demo project

MireDot is a REST API documentation generator for Java. Below you can find the example documentation of our Petstore demo application. Get started with MireDot now! (it's free!)

MireDot gathers information from your Java code (including full generics support), JavaDoc and annotations from JAX-RS and Jackson. Just plug it into your MAVEN build and you're all set.

  • Deprecated.

    Deprecated:

    {{baseUrl.value || ' '}}
       {{role}}{{$last ? '' : ', '}}

    Body

    Accept:
    no type

    Returns

    Content-Type:
    no type

    Response Headers

    Status codes



  • Interfaces not documented

    MireDot believes that the Java methods below correspond to REST interfaces, but somehow had problems parsing/processing these interfaces and therefore excluded them from the generated documentation. We would very much appreciate it if you would send us the interfaces (not the implementations) and the types used (returntype, parameters). This will allow us to further improve MireDot and better document your interfaces in the future.

Below is a list of potential problems detected by MireDot. They can be severe or not. Some of them wil result in low quality documentation, some are real implementation issues. With each warning, the Java method causing the problem is documented.

    • method:

    not shown here because this documentation was generated by the free version of MireDot. As such, not all features are supported.