Smart-doc es una interfaz API de Java reparador herramienta de generación de documentación, smart-doc-documento completo para generar interfaces basadas en el análisis de código fuente, totalmente lograr Notas invasión cero, sólo es necesario para los comentarios de escritura en el estándar de Java, smart-doc puede ayudarle a generar un simple claras de rebajas, HTML, documentos AsciiDoc y una importación de recogida de llaves cartero de datos de prueba. Si no lo hace al igual que otras herramientas de notas invasivos fuerte contaminación, smart-doc le da una opción buena! Como usuario inteligente-doc y no se olvide de proyecto estrella, su apoyo continúa promoviendo smart power-doc.
características
- Notas cero, cero costos de aprendizaje, sólo un estándar de Java para escribir un comentario.
- Automáticamente derivados basa en la definición de interfaz código fuente, un fuerte retorno estructuras derivan.
- Soporte para Spring MVC, Primavera de arranque, arranque primavera Web Flux (notación controlador).
- Soporte Callable, Future, CompletableFuture y otra interfaz asíncrona se deriva devueltos.
- apoyo JSR303 parámetros de calibración estandarizada en un JavaBean, soportes por paquetes, la autenticación.
- Interfaz JSON parámetros de solicitud se pueden generar automáticamente los parámetros de simulación JSON.
- Algunos campos definidos en común se pueden generar analógico válida.
- Generación de un apoyo JSON ejemplar valor de retorno.
- apoyo Notas de generación de campo (incluyendo los estándares paquete tarro publicados) se proyectan desde una fuente externa se carga.
- Generar una variedad de formatos de documentos soportados: de rebajas, HTML5, Asciidoctor, colección del cartero.
- Ver en línea alcanzar fácilmente la documentación API HTML5 estática en servicio de la primavera de arranque.
- Abrir los datos del documento, el libre acceso al sistema de gestión de documentos de lograr.
- Un código de la herramienta de detección de los comentarios, no escriben comentarios socio pequeño no puede escapar el discernimiento.
- Plug-in de integración rápida
Smart-doc vs Swagger
- Smart-doc no Swagger a crear la rueda, este es un concepto completamente diferente de la remodelación de herramienta de generación de documentación de la interfaz API reparador.
- la integración inteligente-doc fácil que arrogancia, que puede generar documentos api libres en múltiples formatos.
- Smart-doc absolutamente ninguna necesidad de escribir cualquier nota en entrar en el código de negocio.
actualizaciones
1. Controlador de etiqueta @ignore tiempo add, la etiqueta puede ser adaptado para ignorar el controlador no necesita para generar un documento [git # 24] (https://github.com/smart-doc-group/smart-doc/issues/24) .
2. Cuando el parámetro comprende una tarjeta principal HttpSession smart-doc, [gitee # I1CA9M] (https://gitee.com/sunyurepository/smart-doc/issues/I1CA9M)
3. paquetes escenarios de problemas complejos dado el smart-doc [gitee # I1CPSM] (https://gitee.com/sunyurepository/smart-doc/issues/I1CPSM) .
4. resolver smart-doc-maven-plugin de complemento lee la configuración ilegible.
plugin de Maven
Inicio de Smart-doc versión 1.7.9. Ofrecemos inteligente plug-in-doc-plugin maven-smart-doc, se recomienda utilizar la última versión del plugin.
Recomendación de actualización
Debido a la reciente ocupado, versión versión corrige algunos problemas de bichos principalmente planteada por los usuarios, pero todavía suave actualizar a las últimas recomendaciones.
MANIFESTACIÓN
Uso de demostración de generación de documentos fácil interfaz Diversión
Los usuarios conocidos
- IFLYTEK
- Una ventaja
- mijo