SpringBootRestAPI

Modèle Restapi - Spring Boot + MongoDB

Dessiner

Un modèle prêt à l'emploi pour l'API REST à l'aide de Spring-Boot-microServices, MongoDB comme base de données, intégré à Codecov et Sonarqube, déployable dans le cloud. Ce modèle peut être branché sur n'importe quelle application pour lancer facilement la tâche sans écrire à partir de zéro.

Progrès de la liste des tâches

• Contrôleurs et modèles de repos utilisant le Springboot
• Configuration MongoDB
• Construction de travisci
• Intégration de Sonarqube
• Rapport de test Jacoco
• Authentification JWT
• 80% et plus de couverture de code (à l'aide de codecov ou de couvertures)
• Déploiement de cloud

Commencer

• Importez ce projet dans votre IDE préféré après la fourche et la vérification de ce référentiel.

Étapes de pré-requis et d'installation

• Obtenez une instance en cours d'exécution de MongoDB à laquelle vous pouvez vous connecter. Pour plus d'informations sur le début de MongoDB, visitez leur tutoriel en ligne.

• Commencez par créer une base de données de test. J'appellerai le mien "REST_TUTORAL" en utilisant la commande suivante dans le shell MongoDB, ou via un gestionnaire de base de données comme MongoDB Compass: use rest_tutorial;

• Créez une collection d'échantillons qui conservera des données sur les différents types d'animaux de compagnie. Créons la collection avec la commande suivante: db.createCollection("pets");

• Une fois la collection créée, nous devons ajouter des données! Nous pouvons ajouter des données à la collection avec la requête ci-dessous, vous pouvez ajouter n'importe quel nombre de données comme ceci: db.pets.insertMany([ { "name" : "Spot", "species" : "dog", "breed" : "pitbull" }, { "name" : "Daisy", "species" : "cat", Bella", "breed" : "calico" }, { "name" : "Bella", "species" : "dog", "breed" : "australian shepard" } ]);

• Ajoutez la Database d'authentification MongoDB, le nom d'utilisateur et le mot de passe dans Application.Properties S'il n'y a pas d'authentification lorsque vous exécutez localement, vous pouvez également supprimer ces propriétés de ce fichier.

• Créez les rôles utilisateur dans la base de données. Les rôles utilisateur peuvent être l'un des "utilisateurs, modérateurs ou administrateurs"

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

Exécuter les tests

Une fois le serveur démontr, votre premier besoin d'enregistrer un utilisateur et de se connecter comme utilisateur pour obtenir un jeton.

enregistrement des utilisateurs

Connexion de l'utilisateur

Une fois que vous avez obtenu le jeton, vous devez passer ce jeton pour chaque demande que vous faites au backend dans le facteur, sélectionnez la section "En-tête" et entrez Authorization pour la clé et
"Porteur" pour la valeur

Vous êtes libre de tester votre API comme vous le souhaitez. Utilisez Postman pour les tests ci-dessous:

getAllpets

getpetbyid

createPet

deletepet

modifypetbyid

Une fois terminé avec tous les tests, vous pouvez vous connecter à l'aide du point de terminaison /api/auth/logout

déconnexion

Couverture de code

Pour l'intégration des rapports de couverture de code, j'ai montré un exemple en utilisant CodeCov et CoverALLS car les deux sont assez populaires et faciles à intégrer avec le Travis.

• CodeCov - Il suffit d'ajouter cette ligne dans le .travis.yml qui enverra le rapport Jacoco à la console Codecov

• CoverAlls - Besoin d'ajouter le plugin CoverAlls et le chemin de rapport Jacoco dans le fichier build.gradle. Besoin également de changement dans .travis.yml au lieu de CodeCov pour utiliser des couvertures

Modèle de demande de problème

Are you up for your first Issue Request for this project !!! Génial, mais veuillez d'abord passer par le modèle de problème.md et utiliser ce modèle pour soumettre une demande de problème.

Modèle de demande de tirage

Are you up for your first PR for this project !!! Génial mais veuillez d'abord passer par le modèle de demande de traction.md et utiliser ce modèle pour soumettre votre PR.

Contributif

Veuillez lire contribution.md et code de conduite.md pour plus de détails sur notre code de conduite, et le processus de soumission des demandes de traction à nous.

Auteurs

• Gourav Rusiya