smart-doc es una herramienta de generación de documentos api de descanso de java. smart-doc se basa en el análisis del código fuente de la interfaz para generar documentos de interfaz, intrusión completamente sin notas, solo necesita escribir comentarios estándar de java, smart-doc puede ayudarlo a generar Datos de prueba simples y claros importados por Markdown, Html, documentos AsciiDoc y la colección Postman. Si no le gusta la fuerte contaminación por anotaciones intrusivas de otras herramientas, ¡smart-doc le ofrece una buena opción! Los usuarios a quienes les gusta smart-doc no deben olvidarse de darle la estrella al proyecto, su apoyo es la fuerza impulsora para que smart-doc continúe avanzando.
Caracteristicas
- Cero anotaciones, cero costo de aprendizaje, solo necesita escribir anotaciones estándar de Java.
- Basado en la definición automática de la interfaz del código fuente, derivación poderosa de la estructura de retorno.
- Admite Spring MVC, Spring Boot, Spring Boot Web Flux (notación de controlador).
- Admite la derivación de Callable, Future, CompletableFuture y otras interfaces asincrónicas.
- Admite la especificación de verificación de parámetros JSR303 en JavaBean, verificación de grupo de soporte.
- La interfaz con los parámetros de solicitud json puede generar automáticamente parámetros json simulados.
- La definición de algunos campos comunes puede generar valores analógicos válidos.
- Soporte para generar el ejemplo de valor de retorno json.
- Soporte para cargar el código fuente desde fuera del proyecto para generar comentarios de campo (incluidos los paquetes jar lanzados por las especificaciones estándar).
- Soporte para generar documentos en múltiples formatos: Markdown, HTML5, Asciidoctor, colección Postman.
- Es fácil ver documentos api HTML5 estáticos en línea en el servicio Spring Boot.
- Datos de documentos abiertos, acceso libre al sistema de gestión de documentos.
- Una herramienta de detección de comentarios de código, los pequeños amigos que no escriben comentarios no pueden escapar de la vista.
- Integración rápida de complementos
Smart-doc vs Swagger
- Smart-doc no es una rueda para Swagger, esta es una herramienta de generación de documentos API API reparadora, desarrollada con un concepto completamente diferente.
- Smart-doc es más simple que la integración swagger y puede generar libremente documentos API en múltiples formatos.
- Smart-doc no necesita escribir ningún comentario en el código comercial.
Actualizar contenido
- Error de exportación de la lista de códigos de error del complemento Maven [git # I1EHXA] (https://gitee.com/sunyurepository/smart-doc/issues/I1EHXA).
- Se agregó soporte para @PatchMapping [gitee # I1EDRF] (https://gitee.com/sunyurepository/smart-doc/issues/I1EDRF)
- Resuelva el problema de que javadoc contiene etiquetas duplicadas para generar documentos [gitee # I1ENNM] (https://gitee.com/sunyurepository/smart-doc/issues/I1ENNM).
- Solucione el problema del error de análisis de datos cuando el parámetro de solicitud es genérico.
- Solucione el problema del puntero nulo de verificación de grupo, no realice el procesamiento de verificación de grupo en los objetos devueltos.
- Optimice smart-doc-maven-plugin para cargar proyectos maven de niveles múltiples.
- Se debe reemplazar el objeto de parámetro de solicitud con otro objeto para representar el documento [función muy importante]
plugin maven
A partir de la versión 1.7.9 de smart-doc. Proporcionamos el complemento smart-doc smart-doc-maven-plugin, se recomienda utilizar la última versión del complemento. Por supuesto, se ha desarrollado el complemento oficial de gradle,
El complemento de Gradle se encuentra actualmente en la etapa de prueba. Los usuarios que usan Gradle pueden primero extraer el código fuente del complemento de Gradle para compilarlo y usarlo y esperar a que se lance la prueba posterior.
Sugerencia de actualización
Esta versión modifica los errores encontrados en el uso de smart-doc 1.8.0 después de la reconstrucción lógica. Se recomienda actualizar sin problemas a la última versión.
MANIFESTACIÓN
Utilice la demostración para generar fácilmente documentos de interfaz
Usuarios conocidos
- IFLYTEK
- Uno más
- Xiaomi