0
W Qmino (firmie, która tworzy Miredot), napisaliśmy setki interfejsów API REST.Projektujemy i przeprojektowujemy, aż nasze interfejsy API sprawią przyjemność.Dokumentacja to interfejs użytkownika interfejsu API.W to mocno wierzymy.Jedynym sposobem, aby naprawdę pochwalić się dobrym API jest dostarczenie pięknej i poprawnej dokumentacji dla programistów.Właśnie dlatego bardzo skrupulatnie dokumentujemy.Pozwoliliśmy nawet, aby brak Javadoc zawiódł w naszych kompilacjach, a przeglądy kodu obejmują sprawdzenie dokumentacji.Oprócz tego powodujemy, że Miredot zawiedzie kompilację, jeśli wykryje cokolwiek złego w dokumentach API REST.Miredot Kilka lat temu naprawdę nie mogliśmy znaleźć żadnego dobrego narzędzia dokumentacji REST API dla Javy.Chcieliśmy czegoś, co zabiera wszelkie istniejące artefakty, takie jak Javadoc, kod źródłowy Java, adnotacje i tak dalej.Coś, co rozumie ramy, których używamy, takie jak jax-rs, spring i jackson, i zamienia je w coś pięknego.Coś, co uwielbiają konsumenci naszych interfejsów API.Właśnie do tego ciągle dążymy z Miredotem.I jak dotąd jesteśmy bardzo dumni z wyniku!
miredot