Chez Qmino (la société qui crée Miredot), nous avons écrit des centaines d'API REST.Nous concevons et repensons jusqu'à ce que nos API soient un plaisir à utiliser.La documentation est l'interface utilisateur d'une API.C'est une chose à laquelle nous croyons fermement.La seule façon de vraiment montrer une bonne API est de fournir une belle documentation correcte aux développeurs.C'est pourquoi nous sommes très méticuleux sur la documentation.Nous avons même laissé le manque de Javadoc échouer dans nos versions et les revues de code incluent la vérification des documents.À côté de cela, nous faisons échouer la construction à Miredot s'il détecte quelque chose de mal avec les documents de l'API REST.Miredot Il y a quelques années, nous ne pouvions vraiment pas trouver de bon outil de documentation de l'API REST pour Java.Nous voulions quelque chose qui prend tous les artefacts existants tels que Javadoc, le code source Java, les annotations, etc.Quelque chose qui comprend les cadres que nous utilisons tels que jax-rs, spring et jackson, et qui en fait quelque chose de beau.Quelque chose que les consommateurs de nos API aiment utiliser.C'est exactement ce que nous visons continuellement avec Miredot.Et jusqu'à présent, nous sommes très fiers du résultat!