Bei Qmino (dem Unternehmen, das Miredot erstellt) haben wir Hunderte von REST-APIs geschrieben.Wir entwerfen und überarbeiten, bis es Freude macht, unsere APIs zu verwenden.Dokumentation ist die Benutzeroberfläche einer API.Daran glauben wir fest.Die einzige Möglichkeit, eine gute API wirklich zur Geltung zu bringen, besteht darin, den Entwicklern eine ansprechende und korrekte Dokumentation zur Verfügung zu stellen.Aus diesem Grund gehen wir bei der Dokumentation sehr akribisch vor.Wir haben sogar zugelassen, dass das Fehlen von Javadoc fehlschlägt. Unsere Builds und Codeüberprüfungen umfassen das Überprüfen der Dokumente.Darüber hinaus wird Miredot veranlasst, den Build nicht auszuführen, wenn Fehler in den REST-API-Dokumenten festgestellt werden.Miredot Vor ein paar Jahren konnten wir wirklich kein gutes REST-API-Dokumentationstool für Java finden.Wir wollten etwas, das vorhandene Artefakte wie Javadoc, den Java-Quellcode, Anmerkungen usw. übernimmt.Etwas, das die von uns verwendeten Frameworks wie jax-rs, spring und jackson versteht und es in etwas Schönes verwandelt.Etwas, das die Verbraucher unserer APIs gerne nutzen.Genau das streben wir mit Miredot kontinuierlich an.Und bis jetzt sind wir sehr stolz auf das Ergebnis!