smart-doc — это инструмент, который поддерживает создание документов интерфейса JAVA REST API и Apache Duadfdso RPC. Smart-doc — первый в отрасли, предлагающий концепцию деривации на основе общих определений JAVA. Он анализирует и генерирует документы интерфейса, полностью основанные на них. исходный код интерфейса без использования каких-либо аннотаций вторгается в бизнес-код. Вам нужно только писать комментарии в соответствии со стандартами java-doc, а smart-doc поможет вам создать простой и понятный документ в Markdown, HTML5, Postman Collection2.0+ и OpenAPI 3.0+.
1. Ноль аннотаций, ноль затрат на обучение, просто напишите стандартные JAVA-аннотации.
2. Автоматический вывод на основе определения интерфейса исходного кода и мощного вывода структуры возврата.
3. Поддержка Spring MVC, Spring Boot, Spring Boot Web Flux (метод написания контроллера), Feign и JAX-RS.
4. Поддерживает получение возвратов из асинхронных интерфейсов, таких как Callable, Future и CompletableFuture.
5. Поддержка спецификации проверки параметров JSR303 на JavaBean, включая групповую проверку.
6. Интерфейс параметров запроса JSON может автоматически генерировать моделируемые параметры JSON.
7. Некоторые общие определения полей могут генерировать действительные значения моделирования.
8. Поддержка создания примеров возвращаемого значения JSON.
9. Поддержка загрузки исходного кода извне проекта для создания комментариев к полям (включая пакеты jar, выпущенные в соответствии со стандартными спецификациями).
10. Поддерживает создание документов в нескольких форматах: Markdown, HTML5, Asciidoctor, Postman Collection, OpenAPI 3.0. Вверх – открытые данные документа, которые можно свободно подключить к системе управления документами.
11. Поддержка экспорта кодов ошибок и различных словарных кодов, определенных в коде, в документ интерфейса.
12. Поддержка простой интеграции плагинов Maven и Gradle.
13. Поддержка создания документов интерфейса Apache Duadfdso RPC.
14. Интерфейс отладки отлаживает страницу HTML5 и полностью поддерживает тестирование загрузки и скачивания файлов (метод загрузки тега загрузки).