{"id":15541,"date":"2020-10-28T03:01:34","date_gmt":"2020-10-28T02:01:34","guid":{"rendered":"http:\/\/blog.wenzlaff.de\/?p=15541"},"modified":"2020-10-28T12:53:23","modified_gmt":"2020-10-28T11:53:23","slug":"rest-service-in-15-min-mit-quarkus-openapi-swagger-ui-und-junit-test-erstellen-und-um-co2-ampel-service-erweitern","status":"publish","type":"post","link":"http:\/\/blog.wenzlaff.de\/?p=15541","title":{"rendered":"REST Service in 15 min mit Quarkus, OpenAPI, Swagger UI und JUnit-Test erstellen und um CO2-Ampel Service erweitern"},"content":{"rendered":"

Einen REST Service in 15 min mit Quarkus, OpenAPI, Swagger UI und JUnit-Test erstellen und um CO2-Ampel Service erweitern ist nicht kompliziert.
\n

\"\"<\/a>
Freut euch immer<\/figcaption><\/figure>
\nVorraussetzungen Java 11 und Maven. Test mit:<\/p>\n

mvn -version<\/strong><\/p>\n

auf der Kommandozeile:<\/p>\n

\u279c  ~ mvn -version\r\nApache Maven 3.6.3 (cecedd343002696d0abb50b32b541b8a6ba2883f)\r\nMaven home: \/opt\/local\/share\/java\/maven3\r\nJava version: 11.0.9, vendor: AdoptOpenJDK, runtime: \/Library\/Java\/JavaVirtualMachines\/adoptopenjdk-11.jdk\/Contents\/Home\r\nDefault locale: de_DE, platform encoding: UTF-8\r\nOS name: \"mac os x\", version: \"10.15.7\", arch: \"x86_64\", family: \"mac\"<\/pre>\n
Dann fangen wir in einem leeren Verzeichnis an<\/p>\n
mkdir rest-co2ampel\r\ncd rest-co2ampel<\/pre>\n
jetzt rufen wir mit dem Maven Quarkus Plugin das create Goal auf:<\/p>\n
mvn io.quarkus:quarkus-maven-plugin:1.9.0.Final:create -DprojectGroupId=de.wenzlaff.co2ampel -DprojectArtifactId=info-kleinhirn -DclassName=\"de.wenzlaff.Co2AmpelResource\" -Dpath=\"\/co2ampel\"<\/pre>\n
Zwei Sekunden sp\u00e4ter, ist das Projekt angelegt:<\/p>\n
\r\n[INFO] ========================================================================================\r\n[INFO] Your new application has been created in \/Users\/thomaswenzlaff\/rest-co2ampel\/info-kleinhirn\r\n[INFO] Navigate into this directory and launch your application with mvn quarkus:dev\r\n[INFO] Your application will be accessible on http:\/\/localhost:8080\r\n[INFO] ========================================================================================\r\n[INFO]\r\n[INFO] ------------------------------------------------------------------------\r\n[INFO] BUILD SUCCESS\r\n[INFO] ------------------------------------------------------------------------\r\n[INFO] Total time:  1.898 s\r\n[INFO] Finished at: 2020-10-27T12:57:17+01:00\r\n[INFO] ------------------------------------------------------------------------\r\n<\/pre>\n
Nun gehen wir in das erzeugte Verzeichnis: cd info-kleinhirn<\/strong><\/p>\n
Nun starten wir den build und den Server mit:<\/p>\n
mvn quarkus:dev<\/strong><\/p>\n
Ein paar Sekunden sp\u00e4ter ist alles gebaut, und der Server l\u00e4uft:<\/p>\n
\r\n[INFO] Compiling 1 source file to \/Users\/thomaswenzlaff\/rest-co2ampel\/info-kleinhirn\/target\/classes\r\nListening for transport dt_socket at address: 5005\r\n__  ____  __  _____   ___  __ ____  ______\r\n --\/ __ \\\/ \/ \/ \/ _ | \/ _ \\\/ \/\/_\/ \/ \/ \/ __\/\r\n -\/ \/_\/ \/ \/_\/ \/ __ |\/ , _\/ ,< \/ \/_\/ \/\\ \\\r\n--\\___\\_\\____\/_\/ |_\/_\/|_\/_\/|_|\\____\/___\/\r\n2020-10-27 13:00:57,115 INFO  [io.quarkus] (Quarkus Main Thread) info-kleinhirn 1.0-SNAPSHOT on JVM (powered by Quarkus 1.9.0.Final) started in 0.836s. Listening on: http:\/\/0.0.0.0:8080\r\n2020-10-27 13:00:57,118 INFO  [io.quarkus] (Quarkus Main Thread) Profile dev activated. Live Coding activated.\r\n2020-10-27 13:00:57,118 INFO  [io.quarkus] (Quarkus Main Thread) Installed features: [cdi, resteasy]\r\n<\/pre>\n
Ein Aufruf von <\/p>\n
http:\/\/localhost:8080\/<\/a> <\/p>\n
bringt die statische Webseite. Und ein <\/p>\n
http:\/\/localhost:8080\/co2ampel<\/a><\/p>\n
liefert den Aufruf des REST CO2Ampel Services.<\/p>\n
Nun unterbrechen wir den Server mit CTLR-C und erg\u00e4nzen f\u00fcr den Test die Swaggert GUI hinzu, einfach ein<\/p>\n
.\/mvnw quarkus:add-extension -Dextensions=\"quarkus-smallrye-openapi\"<\/pre>\n
und ein neues starten:<\/p>\n
.\/mvnw compile quarkus:dev<\/strong><\/p>\n
Dann im Browser die GUI Aufrufen:<\/p>\n
http:\/\/localhost:8080\/swagger-ui\/<\/a><\/p>\n
Cool:<\/p>\n
\"\"<\/a><\/p>\n
Und openapi geht auch, einfach in einem neuen Fenster ein <\/p>\n
curl http:\/\/localhost:8080\/openapi <\/strong><\/p>\n
\"\"<\/a><\/p>\n
So, jetzt nur noch echt CO2 Messung einbauen. Ich habe einen Mqtt-Broker der die Werte liefert.<\/p>\n
Wir gehen in das Verzeichnis und \/rest-co2ampel\/info-kleinhirn\/src\/main\/java\/de\/wenzlaff<\/strong> und holen uns die zwei Beispielklasse von github mit:<\/p>\n
\r\ncurl https:\/\/gist.githubusercontent.com\/IT-Berater\/c58da54b1f20337827f8de827715d728\/raw\/10d721ca73148b3be195d6fc2fa45ff02af42d9d\/CO2AmpelResource.java > CO2AmpelResource.java\r\n\r\ncurl https:\/\/gist.githubusercontent.com\/IT-Berater\/dc7695fdb406d6f93d4a47553d309ec9\/raw\/a7928a1527d164d2a51ddece19fefc431c3c46a1\/MqttCo2Client.java > MqttCo2Client.java<\/pre>\n
Dann gehen wir in das Wurzelverzeichnis des Projektes und f\u00fcgen in der pom.xml<\/strong> diese beiden abh\u00e4ngigkeiten hinzu:<\/p>\n
\r\n<dependency>\r\n   <groupId>org.eclipse.paho<\/groupId>\r\n   <artifactId>org.eclipse.paho.client.mqttv3<\/artifactId>\r\n   <version>1.2.5<\/version>\r\n<\/dependency>\r\n<dependency>\r\n  <groupId>org.json<\/groupId>\r\n  <artifactId>json<\/artifactId>\r\n  <version>20200518<\/version>\r\n<\/dependency>\r\n<\/pre>\n
Dann m\u00fcssen wir noch den JUnit Test anpassen.Dazu die Testklasse Co2AmpelResourceTest.java in der Methode testHelloEndpoint() diesen Inhalt einf\u00fcgen: <\/p>\n
given().when().get(\"\/v1\/rest\/co2\").then().statusCode(200).body(is(\"CO2 Wert: 0\"));<\/pre>\n
So, nun k\u00f6nnen wir das Projekt starten:<\/p>\n
.\/mvnw compile quarkus:dev <\/strong><\/p>\n
So der JUnit Test wurde erfolgreich ausgef\u00fchrt. Nun kann der REST-Service \u00fcber die URL<\/p>\n
http:\/\/localhost:8080\/v1\/rest\/co2<\/a><\/p>\n
abgefragt werden. Wenn der Mqtt-Service Werte die entsprechenden Werte liefert, sonst 0 \ud83d\ude09<\/p>\n
Und auch \u00fcber die openapi stehen die REST-Services bereit, cool ...<\/p>\n
\"\"<\/a><\/p>\n
\"\"<\/a><\/p>\n
Openapi geht auch:<\/p>\n
\"\"<\/a><\/p>\n
Und hier, wenn der Mqtt-Server echte Werte liefert (evl. den Server localhost in der Java-Klasse MqttCo2Client durch einen anderen ersetzen, bei mir l\u00e4uf der CO2-Sensor auf einem Raspberry Pi, wie hier im Blog beschrieben):<\/p>\n
\"\"<\/a><\/p>\n
So, jetzt muss ich aber l\u00fcften ...\"\"<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"
REST-Api mit Quarkus in 15 Minuten erstellen<\/p>\n","protected":false},"author":2,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[220,4084,5,3423,808,3773,3163,79],"tags":[4108,4057,2178,4110,3764,2487,4109,4107,4106],"class_list":["post-15541","post","type-post","status-publish","format-standard","hentry","category-anleitung","category-co2","category-java","category-java-11","category-linux-2","category-mac-os","category-maven","category-programmierung","tag-co","tag-co2ampel","tag-java","tag-openapi","tag-quarkus","tag-rest","tag-rest-service","tag-swaggert","tag-swaggert-ui"],"_links":{"self":[{"href":"http:\/\/blog.wenzlaff.de\/index.php?rest_route=\/wp\/v2\/posts\/15541","targetHints":{"allow":["GET"]}}],"collection":[{"href":"http:\/\/blog.wenzlaff.de\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/blog.wenzlaff.de\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/blog.wenzlaff.de\/index.php?rest_route=\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"http:\/\/blog.wenzlaff.de\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=15541"}],"version-history":[{"count":0,"href":"http:\/\/blog.wenzlaff.de\/index.php?rest_route=\/wp\/v2\/posts\/15541\/revisions"}],"wp:attachment":[{"href":"http:\/\/blog.wenzlaff.de\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=15541"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/blog.wenzlaff.de\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=15541"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/blog.wenzlaff.de\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=15541"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}