Description

En Qmino (la compañía que crea Miredot), hemos escrito cientos de API REST. Diseñamos y rediseñamos hasta que nuestras API son un placer de usar.

La documentación es la interfaz de usuario de una API.

Eso es algo que cree firmemente La única forma de mostrar realmente una buena API es proporcionar una documentación hermosa y correcta para que los desarrolladores la disfruten.

Es por eso que somos muy meticulosos en la documentación. Incluso dejamos que la falta de Javadoc falle en nuestras compilaciones y las revisiones de código incluyen la comprobación de los documentos. Además de eso, hacemos que Miredot falle en la compilación si detecta algo incorrecto con los documentos de la API REST.
Miredot

Hace unos años, no pudimos encontrar ninguno buena herramienta de documentación REST API para Java. Queríamos algo que tomara cualquier artefacto existente como Javadoc, el código fuente de Java, anotaciones, etc. Algo que entiende los marcos que usamos como jax-rs, spring y jackson, y lo convierte en algo hermoso. Algo que a los consumidores de nuestras API les encanta usar.

Eso es exactamente lo que buscamos continuamente con Miredot. Y, hasta ahora, estamos muy orgullosos del resultado!

Categorías