0
Hos Qmino (det firma, der opretter Miredot), har vi skrevet hundreder af REST-API'er.Vi designer og redesign, indtil vores API'er er en glæde at bruge.Dokumentation er brugergrænsefladen til en API.Det er noget, vi tror på.Den eneste måde at virkelig fremvise et godt API er ved at give smuk og korrekt dokumentation for udviklere at nyde.Derfor er vi meget omhyggelige med dokumentation.Vi lader endda manglen på Javadoc svigte vores builds, og kodevurderinger inkluderer kontrol af dokumenterne.Dernæst får vi Miredot til at mislykkes med build, hvis det registrerer noget galt med REST API-dokumenter.Miredot For nogle få år siden kunne vi virkelig ikke finde noget godt REST API-dokumentationsværktøj til Java.Vi ønskede noget, der tager alle eksisterende artefakter, såsom Javadoc, Java-kildekoden, kommentarer og så videre.Noget, der forstår de rammer, vi bruger sådan som jax-rs, forår og jackson, og gør det til noget smukt.Noget, som forbrugere af vores API'er elsker at bruge.Det er nøjagtigt, som vi kontinuerligt sigter mod med Miredot.Og indtil videre er vi meget stolte af resultatet!