Miredot генерирует документацию REST API прямо из ваших существующих источников Java!
Miredot генерирует документацию REST API прямо из ваших существующих источников Java!
MireDot Платформы
Windows
Linux
Mac
MireDot Обзор
В Qmino (компания, которая создает Miredot), мы написали сотни REST API. Мы разрабатываем и обновляем дизайн до тех пор, пока наши API не станут удовольствием для использования.
Документация - это пользовательский интерфейс API.
Это то, во что мы твердо верим. Единственный способ действительно продемонстрировать хороший API - предоставить красивую и правильную документацию для разработчиков.
Вот почему мы очень дотошны в документации. Мы даже позволяем отсутствию Javadoc проваливать наши сборки, а обзоры кода включают проверку документации. Кроме того, мы заставляем Miredot отказывать в сборке, если он обнаруживает что-то не так с документами REST API. Miredot
Несколько лет назад мы действительно не смогли найти ни одного хорошего инструмента документации REST API для Java. Мы хотели что-то, что принимает любые существующие артефакты, такие как Javadoc, исходный код Java, аннотации и так далее. Что-то, что понимает рамки, которые мы используем, такие как jax-rs, Spring и Jackson, и превращает это во что-то прекрасное. Нечто, что потребители наших API любят использовать.
Именно к этому мы постоянно стремимся с помощью Miredot. И пока мы очень гордимся результатом!