V spoločnosti Qmino (spoločnosť, ktorá vytvára Miredot), sme napísali stovky REST API.Navrhujeme a prepracovávame, kým naše rozhrania API nebudú mať radosť z používania.Dokumentácia je používateľské rozhranie API.V to pevne veríme.Jediným spôsobom, ako sa skutočne pochváliť dobrým rozhraním API, je poskytnúť nádhernú a správnu dokumentáciu pre vývojárov.Preto sme veľmi dôkladní v súvislosti s dokumentáciou.Dokonca sme nechali zlyhanie Javadocu zlyhať, naše zostavenia a kontroly kódu zahŕňajú kontrolu dokumentov.Ďalej spôsobíme, že Miredot zlyhá pri zostavovaní, ak zistí niečo nesprávne v dokumentoch REST API.Miredot Pred pár rokmi sme naozaj nenašli žiadny dobrý dokumentačný nástroj REST API pre Java.Chceli sme niečo, čo má akékoľvek existujúce artefakty, ako napríklad Javadoc, zdrojový kód Java, anotácie atď.Niečo, čo chápe rámce, ktoré používame, napríklad jax-rs, jar a jackson, a mení ich na niečo krásneho.Niečo, čo zákazníci našich rozhraní API radi používajú.To je presne to, na čo sa neustále zameriavame s Miredotom.A zatiaľ sme na výsledok veľmi hrdí!