SpringBootRestAPI

Plantilla de restapi - Boot de primavera + MongoDB

Descifrado

Una plantilla lista para usar para REST API utilizando microservicios de boot spring-boot, MongoDB como base de datos, integrada con CodeCov y Sonarqube, implementable en Cloud. Esta plantilla se puede conectar a cualquier aplicación para iniciar la tarea fácilmente sin escribir todo desde cero.

Progreso de la lista de tareas

• Controladores de descanso y modelos que usan Springboot
• Configuración de MongoDB
• Travisci Build
• Integración de Sonarqube
• Informe de prueba de jacoco
• Autenticación JWT
• Cobertura de código de 80% y superior (usando CodeCov o Coveralls)
• Implementación en la nube

Empezando

• Importe este proyecto en su IDE favorito después de la bifurcación y el pago de este repositorio.

Requisito previo e instalación de pasos

• Obtenga una instancia en ejecución de MongoDB con la que pueda conectarse. Para obtener más información sobre cómo comenzar con MongoDB, visite su tutorial en línea.

• Comience creando una base de datos de prueba. Llamaré a la mía "REST_TUTORIOR" usando el siguiente comando en el shell MongoDB, o a través de un administrador de base de datos como MongoDB Compass: use rest_tutorial;

• Cree una colección de muestras que contenga datos sobre diferentes tipos de mascotas. Creemos la colección con el siguiente comando: db.createCollection("pets");

• Una vez que se crea la colección, ¡necesitamos agregar algunos datos! We can add data to the collection with the below query, you can add any number of data like this : db.pets.insertMany([ { "name" : "Spot", "species" : "dog", "breed" : "pitbull" }, { "name" : "Daisy", "species" : "cat", "breed" : "calico" }, { "name" : "Bella", "species" : "dog", "breed" : "australian shepard" } ]);

• Agregue la autenticación MongoDB-Database, el nombre de usuario y la contraseña en Application.Properties Si no hay autenticación cuando se ejecuta localmente, también puede eliminar estas propiedades de este archivo.

• Cree los roles de usuario en la base de datos. Los roles de usuario pueden ser uno de "usuario, moderador o administrador"

 db.roles.insertMany([
   { name: "ROLE_USER" },
   { name: "ROLE_MODERATOR" },
   { name: "ROLE_ADMIN" },
])

Ejecutando las pruebas

Una vez que se inicia el servidor, su primera debe registrar a un usuario e iniciar sesión como ese usuario para obtener un token.

registro de usuarios

Inicio de sesión de usuario

Una vez que obtenga el token, debe aprobar ese token para cada solicitud que realice al backend en el cartero, seleccione la sección "Encabezado" e ingrese Authorization de la clave y
"Portador" por el valor

Usted es libre de probar su API como elija. Use Postman para las pruebas a continuación:

GetAllpets

getpetbyid

createpet

deletrepet

modifypetbyid

Una vez hecho con todas las pruebas, puede cerrar sesión utilizando el punto final /api/auth/logout

cierre de sesión

Cobertura de código

Para la integración de informes de cobertura de código, he mostrado un ejemplo usando CodeCov y Coverls, ya que ambos son bastante populares y fáciles de integrar con el Travis.

• CodeCov: solo agregue esta línea en .travis.yml que enviará el informe Jacoco a la consola CodeCoV

• Coveralls: necesita agregar el complemento de Coveralls y la ruta del informe Jacoco en el archivo Build.gradle. También necesita un cambio en .travis.yml en lugar de codecov para usar coverls

Plantilla de solicitud de emisión

Are you up for your first Issue Request for this project !!! Impresionante, pero primero revise la plantilla de problemas.md y use esta plantilla para enviar cualquier solicitud de problema.

Plantilla de solicitud de extracción

Are you up for your first PR for this project !!! Impresionante, pero primero revise la plantilla de solicitud de extracción.md y use esta plantilla para enviar su PR.

Que contribuye

Lea contribuyente. MD y Código de conducta. MD para obtener detalles sobre nuestro código de conducta y el proceso para enviarnos solicitudes de extracción.

Autores

• Gourav rusiya