En proyectos multimodelo, utilice Swagger
Cuando conocí el primer proyecto de la empresa durante mis prácticas, ya había visto las anotaciones Swagger en el proyecto. Pero no sé mucho al respecto y ni siquiera sé qué hace. Lo estudié un poco hoy y aquí registré brevemente cómo se integra y usa Swagger en proyectos multimodelo.
En el modelo de desarrollo de separación de front-end y back-end, los documentos API son la mejor manera de comunicarse.
Swagger es un framework estandarizado y completo para generar, describir, invocar y visualizar servicios web estilo RESTful.
1. Puntualidad (después de cambiar la interfaz, los desarrolladores de front-end y back-end relevantes pueden ser notificados de manera rápida y precisa)
2. Estandarización (y garantizar la estandarización de la interfaz, como la dirección de la interfaz, el método de solicitud, los parámetros y el formato de respuesta y el mensaje de error)
3. Coherencia (la información de la interfaz es consistente y no habrá desacuerdos debido a versiones inconsistentes de los documentos obtenidos por desarrolladores)
4. Capacidad de prueba (pruebe directamente en el documento de la interfaz para facilitar la comprensión empresarial)
En el proceso diario de escribir interfaces, algunas interfaces no se pueden probar directamente en el navegador. En este momento podemos utilizar herramientas de prueba de interfaz.
Entre las herramientas de prueba de interfaz que conozco, las más utilizadas son Postman y Swagger. Pero para los desarrolladores backend, se prefiere Swagger.
Tome mi proyecto multimodelo como ejemplo
Cree un módulo común en el proyecto principal de nivel superior e introduzca la dependencia Swagger en su archivo pom.xml
Importar Después de confiar en él, cree el módulo common_base en el módulo común y cree la clase de configuración Swagger
Clase de configuración Swagger:
De esta manera, Swagger está configurado aproximadamente Siguiente. , introdúzcalo en el módulo de interfaz.
Introduzca service_base en el módulo service module
Agregue la anotación @ComponentScan en la clase de inicio del módulo service_edu, un submódulo de service
En este De esta manera, podemos probar la interfaz funcional a través de Swagger.
También podemos realizar algunas configuraciones personalizadas
1. Inicia tu proyecto
2. Accede a la ruta http://localhost:tu número de puerto/ swagger- ui.html
3. Prueba
Aquí utilizo la consulta de la lista de profesores como ejemplo
Lo anterior es una breve introducción al método de integración de prueba de interfaz usando arrogancia.