Duo-Doc 文档

Проектное описание

Duo-Doc — это расширение Javadoc, которое не вмешивается в код, автоматически извлекает информацию об интерфейсах проекта и документацию путём анализа комментариев кода и структуры файлов проекта, а затем представляет её через внешний проект (duo-doc-angular).

Основные функции, которые уже реализованы:

1. Автоматическое создание документации по интерфейсам (поддерживает автономное чтение и markdown).
2. Поддержка прямого вызова интерфейсов для нескольких сред (тестирование, предварительная версия, производство) (RESTful, Dubbo).
3. Сохранение и совместное использование параметров вызова интерфейса.
4. Генерация кода для вызовов (curl / java / javascript).
5. RESTful-интерфейс Mock (нужна ли имитация интерфейса Dubbo?).
6. Модель SaaS (на основе изоляции доменов).
7. ...

Архитектура проекта

Проектная архитектура Duo-Doc состоит из четырёх частей:

1. duo-doclet — реализация Javadoclet, поскольку Javadoclet генерирует документацию по классам, duo-doclet переопределяет реализацию по умолчанию и сам не генерирует документацию по классу, но анализирует исходный файл, извлекает информацию о интерфейсе (включая сигнатуру интерфейса, входные параметры, ответ, документацию в формате markdown и т. д.) и выводит её. Существует несколько форм вывода, таких как отправка на сервер документов, api.json, вывод структуры в формате markdown.
2. invoker — вызывающий объект, используемый для вызова интерфейса, если развёрнуто несколько сред, вызывающий объект можно развернуть в каждой среде для реализации вызова в нескольких средах.
3. duo-doc service — фоновый сервис duo-doc, который предоставляет интерфейс в стиле RESTful, используется для загрузки данных duo-doclet и извлечения/вызова веб-терминала, а также предоставления метаданных интерфейса для сторонних приложений (например, предоставление метаданных интерфейса для duo-graphql).
4. web — терминал для отображения документов, в настоящее время предоставляет стандартный интерфейс и реализует все функции (при необходимости его можно переписать напрямую).

DEMO

Официальный сайт предоставляет простую демонстрацию DEMO. В настоящее время не создана среда Dubbo, поэтому демонстрация вызова Dubbo пока недоступна.

Функциональная диаграмма

Проектная документация

• Руководство по установке.
• Документация по подключению.
• Вызов интерфейса.
• Mock.
• Обычная операция.

Особое примечание

В настоящее время проект поддерживает только JDK8. Если вам нужна поддержка большего количества версий, обратитесь к: https://www.duoec.com.