Ve společnosti Qmino (společnost, která vytváří Miredot), jsme napsali stovky REST API.Navrhujeme a přepracováváme, dokud naše API nebudou mít radost.Dokumentace je uživatelské rozhraní API.V to pevně věříme.Jediným způsobem, jak opravdu předvést dobré API, je poskytnout krásnou a správnou dokumentaci pro vývojáře, aby si ji mohli užít.Proto jsme velmi pečliví v dokumentaci.Dokonce jsme nechali nedostatek Javadoc selhat naše sestavení a recenze kódu zahrnují kontrolu dokumentů.Kromě toho jsme se nechat Miredot selhání sestavení, pokud zjistí něco špatného s dokumenty REST API.Miredot Před pár lety jsme opravdu nenašli žádný dobrý dokumentační nástroj REST API pro Javu.Chtěli jsme něco, co vezme všechny existující artefakty, jako je Javadoc, zdrojový kód Java, anotace atd.Něco, co chápe rámce, které používáme jako jax-rs, jaro a jackson, a proměňuje to v něco krásného.Něco, co zákazníci našich API rádi používají.To je přesně to, na co se neustále zaměřujeme s Miredotem.A zatím jsme na výsledek velmi hrdí!