SpringBootRestAPI

RESTAPI -Vorlage - Spring Boot + MongoDB

Entfernung

Eine vorhandene Vorlage für REST-API mit Spring-Boot-Mikroservices, MongoDB als Datenbank, integriert in Codecov und Sonarqube, die für Cloud bereitgestellt werden können. Diese Vorlage kann in jede Anwendung angeschlossen werden, um die Aufgabe problemlos zu starten, ohne alles von Grund auf neu zu schreiben.

Aufgabenliste Fortschritt

• REST -Controller und Modelle mit Springboot
• MongoDB -Konfiguration
• Travisci Build
• Sonarqube -Integration
• Jacoco -Testbericht
• JWT -Authentifizierung
• 80% und über Codeabdeckung (mit Codecov oder Coveralls)
• Cloud -Bereitstellung

Erste Schritte

• Importieren Sie dieses Projekt in Ihre bevorzugte IDE nach der Gabelung und Kasse dieses Repositorys.

Voraussetzung und Installation von Schritten

• Holen Sie sich eine laufende Instanz von MongoDB, mit der Sie eine Verbindung herstellen können. Weitere Informationen zum Einstieg mit MongoDB finden Sie in ihrem Online -Tutorial.

• Erstellen Sie zunächst eine Testdatenbank. Ich werde meine "rest_tutorial" mit dem folgenden Befehl in der MongoDB -Shell oder über einen Datenbankmanager wie MongoDB Compass nennen: use rest_tutorial;

• Erstellen Sie eine Beispielsammlung mit Daten zu verschiedenen Arten von Haustieren. Erstellen wir die Sammlung mit dem folgenden Befehl: db.createCollection("pets");

• Sobald die Sammlung erstellt wurde, müssen wir einige Daten hinzufügen! "species" : "dog", "species" : "dog", db.pets.insertMany([ { "breed" : "pitbull" "species" : "cat", "breed" : "calico" "name" : "Daisy", "name" : "Spot", { }, }, { "name" : "Bella", "breed" : "australian shepard" } ]);

• Fügen Sie die MongoDB-Authentifizierungsdatabase, den Benutzernamen und das Kennwort in application.properties hinzu, wenn Sie keine Authentifizierung vorhanden sind, wenn Sie lokal ausgeführt werden, können Sie diese Eigenschaften auch aus dieser Datei entfernen.

• Erstellen Sie die Benutzerrollen in der Datenbank. Die Benutzerrollen können "Benutzer, Moderator oder Administrator" sein.

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

Die Tests ausführen

Sobald der Server startet, müssen Sie einen Benutzer registrieren und sich als Benutzer anmelden, um ein Token zu erhalten.

Benutzerregistrierung

Benutzeranmeldung

Sobald Sie das Token erhalten haben, müssen Sie dieses Token für jede Anfrage zum Backend im Postanläufer übergeben, wählen Sie den Abschnitt "Header" und geben Sie Authorization für den Schlüssel ein und geben Sie die Autorisierung ein
"Träger" für den Wert

Sie können Ihre API, wie Sie sich entscheiden, frei testen. Verwenden Sie den Postboten für die folgenden Tests:

GetAllpets

GetpetbyId

Createpet

deletepet

ModifypetbyId

Sobald Sie mit allen Tests durchgeführt werden, können Sie sich mit dem Endpoint /api/auth/logout anmelden

Abmelden

Codeabdeckung

Für die Integration von Code -Deckungsberichten habe ich Beispiele mit Codecov und Coveralls gezeigt, da beide ziemlich beliebt und einfach in die Travis zu integrieren sind.

• Codecov - Fügen Sie diese Zeile einfach in die .travis.yml hinzu, die den Jacoco -Bericht an die Codecov -Konsole sendet

• Coveralls - Müssen Coveralls -Plugin- und Jacoco -Berichtspfad in der build.gradle -Datei hinzufügen. Benötigen auch Veränderung in .travis.yml anstelle von codcov, um Coveralls zu verwenden

Anfragesvorlage ausgeben

Are you up for your first Issue Request for this project !!! Fantastisch, aber bitte gehen Sie zuerst die Ausgabevorlage.MD durch und verwenden Sie diese Vorlage, um eine Ausgabeanfrage einzureichen.

Anforderungsvorlage ziehen

Are you up for your first PR for this project !!! Fantastisch, aber bitte gehen Sie zuerst die Pull -Anfrage -Vorlage.MD und verwenden Sie diese Vorlage, um Ihre PR zu senden.

Beitragen

Bitte lesen Sie den Beitrag.md und den Verhaltenskodex.MD für Informationen zu unserem Verhaltenskodex sowie zum Vorgang zum Senden von Pull -Anfragen an uns.

Autoren

• Gourav Rusiya