OpenAPI, fr\u00fcher bekannt als Swagger, ist eine weit verbreitete Spezifikation zur Beschreibung von RESTful APIs. Es erm\u00f6glicht Entwicklern, die Struktur ihrer APIs in einem standardisierten Format zu definieren, was die Interoperabilit\u00e4t zwischen verschiedenen Systemen und Technologien erleichtert. In der Java-Entwicklung spielt OpenAPI eine wichtige Rolle bei der Dokumentation, Generierung und Validierung von API-Schnittstellen.<\/p>\n\n\n\n
OpenAPI ist eine Spezifikation f\u00fcr maschinenlesbare Schnittstellen von Webservices. Es beschreibt die verf\u00fcgbaren Endpunkte, deren Parameter, R\u00fcckgabewerte und andere Aspekte einer API. Das Format ist JSON- oder YAML-basiert, was es sowohl menschen- als auch maschinenlesbar macht. Mit der OpenAPI-Spezifikation kann ein breites Spektrum an Werkzeugen genutzt werden, um Dokumentation zu generieren, Code zu erzeugen oder Tests durchzuf\u00fchren.<\/p>\n\n\n\n
In der Java-Entwicklung gibt es verschiedene Bibliotheken und Frameworks, die die Integration von OpenAPI unterst\u00fctzen. Diese Tools vereinfachen die Erstellung, Wartung und Nutzung von APIs erheblich. Zu den bekanntesten geh\u00f6ren Swagger, Springfox, und OpenAPI Generator.<\/p>\n\n\n\n
Swagger ist das bekannteste Toolset zur Nutzung der OpenAPI-Spezifikation. Es bietet eine Reihe von Tools, darunter Swagger Editor, Swagger UI und Swagger Codegen. Springfox ist eine Bibliothek, die die Integration von Swagger in Spring Boot-Anwendungen erleichtert.<\/p>\n\n\n\n
Um Springfox in ein Spring Boot-Projekt zu integrieren, m\u00fcssen einige Abh\u00e4ngigkeiten in der Nach dem Hinzuf\u00fcgen der Abh\u00e4ngigkeiten kann die Konfiguration der API-Dokumentation beginnen. Dies geschieht durch die Erstellung einer Konfigurationsklasse:<\/p>\n\n\n Diese Konfiguration scannt alle Controller im Paket Der OpenAPI Generator ist ein weiteres m\u00e4chtiges Werkzeug, das aus einer OpenAPI-Spezifikation Client- und Servercode f\u00fcr verschiedene Programmiersprachen generieren kann, einschlie\u00dflich Java. Es bietet zahlreiche Generatoren f\u00fcr unterschiedliche Frameworks wie Spring, JAX-RS und viele mehr.<\/p>\n\n\n\n Um den OpenAPI Generator zu nutzen, muss die OpenAPI-Spezifikation in einer JSON- oder YAML-Datei vorliegen. Angenommen, wir haben eine Dieser Befehl verwendet den OpenAPI Generator CLI, um den Servercode basierend auf der OpenAPI-Spezifikation zu erzeugen. Der Eine der Hauptanwendungen von OpenAPI ist die Dokumentation von APIs. Durch die Nutzung von Swagger UI oder anderen Tools k\u00f6nnen Entwickler und Anwender eine interaktive Dokumentation erstellen, die es erm\u00f6glicht, Endpunkte direkt auszuprobieren.<\/p>\n\n\n\n Ein weiteres n\u00fctzliches Feature ist die Codegenerierung. Mit Tools wie OpenAPI Generator k\u00f6nnen Entwickler sowohl Server- als auch Clientcode aus einer einzigen Spezifikation generieren. Dies spart Zeit und reduziert das Risiko von Inkonsistenzen zwischen verschiedenen Implementierungen.<\/p>\n\n\n\n OpenAPI kann auch zur Validierung von API-Anfragen und -Antworten verwendet werden. Frameworks wie Spring bieten Middleware an, die eingehende Anfragen gegen die OpenAPI-Spezifikation validiert und sicherstellt, dass sie den definierten Anforderungen entsprechen.<\/p>\n\n\n\n Im Folgenden wird ein vollst\u00e4ndiges Beispiel gezeigt, wie eine RESTful API mit OpenAPI und Spring Boot erstellt wird.<\/p>\n\n\n\n Erstellen Sie ein neues Spring Boot-Projekt mit den folgenden Abh\u00e4ngigkeiten in der Erstellen Sie einen einfachen Controller, um eine RESTful API zu definieren:<\/p>\n\n\n F\u00fcgen Sie die Swagger-Konfigurationsklasse hinzu, um die Dokumentation zu aktivieren:<\/p>\n\n\n Starten Sie die Anwendung und rufen Sie die Swagger-UI unter OpenAPI bietet eine leistungsstarke M\u00f6glichkeit, RESTful APIs zu dokumentieren, zu validieren und zu generieren. In der Java-Entwicklung vereinfachen Tools wie Swagger und OpenAPI Generator die Arbeit erheblich, indem sie den Entwicklungsprozess standardisieren und automatisieren. Die Verwendung von OpenAPI tr\u00e4gt zur Verbesserung der Codequalit\u00e4t und der Zusammenarbeit zwischen Teams bei, indem sie klare und einheitliche API-Spezifikationen bereitstellt.<\/p>\n","protected":false},"excerpt":{"rendered":" Einf\u00fchrung OpenAPI, fr\u00fcher bekannt als Swagger, ist eine weit verbreitete Spezifikation zur Beschreibung von RESTful APIs. Es erm\u00f6glicht Entwicklern, die Struktur ihrer APIs in einem standardisierten Format zu definieren, was die Interoperabilit\u00e4t zwischen verschiedenen Systemen und Technologien erleichtert. In der Java-Entwicklung spielt OpenAPI eine wichtige Rolle bei der Dokumentation, Generierung und Validierung von API-Schnittstellen. Was […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[4,5],"tags":[],"class_list":["post-332","post","type-post","status-publish","format-standard","hentry","category-plain_java","category-spring"],"_links":{"self":[{"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=\/wp\/v2\/posts\/332","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=332"}],"version-history":[{"count":1,"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=\/wp\/v2\/posts\/332\/revisions"}],"predecessor-version":[{"id":333,"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=\/wp\/v2\/posts\/332\/revisions\/333"}],"wp:attachment":[{"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=332"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=332"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.xn--javaeinfacherklrt-4qb.de\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=332"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}pom.xml<\/code>-Datei hinzugef\u00fcgt werden:<\/p>\n\n\n<dependency<\/span>><\/span>\n <groupId<\/span>><\/span>io.springfox<\/groupId<\/span>><\/span>\n <artifactId<\/span>><\/span>springfox-boot-starter<\/artifactId<\/span>><\/span>\n <version<\/span>><\/span>3.0.0<\/version<\/span>><\/span>\n<\/dependency<\/span>><\/span><\/code><\/span>Code-Sprache:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\nimport<\/span> org<\/span>.springframework<\/span>.context<\/span>.annotation<\/span>.Bean<\/span>;\nimport<\/span> org<\/span>.springframework<\/span>.context<\/span>.annotation<\/span>.Configuration<\/span>;\nimport<\/span> springfox<\/span>.documentation<\/span>.builders<\/span>.RequestHandlerSelectors<\/span>;\nimport<\/span> springfox<\/span>.documentation<\/span>.spi<\/span>.DocumentationType<\/span>;\nimport<\/span> springfox<\/span>.documentation<\/span>.spring<\/span>.web<\/span>.plugins<\/span>.Docket<\/span>;\nimport<\/span> springfox<\/span>.documentation<\/span>.swagger2<\/span>.annotations<\/span>.EnableSwagger2<\/span>;\n\n@Configuration<\/span>\n@EnableSwagger2\npublic class SwaggerConfig {\n\n @Bean<\/span>\n public Docket api() {\n return<\/span> new<\/span> Docket<\/span>(DocumentationType<\/span>.SWAGGER_2<\/span>)\n .select<\/span>()\n .apis<\/span>(RequestHandlerSelectors<\/span>.basePackage<\/span>(\"com<\/span>.example<\/span>.api<\/span>\"))\n .build<\/span>();\n }\n}<\/code><\/span>Code-Sprache:<\/span> CSS<\/span> (<\/span>css<\/span>)<\/span><\/small><\/pre>\n\n\ncom.example.api<\/code> und generiert automatisch die OpenAPI-Dokumentation. Die generierte Dokumentation kann dann unter http:\/\/localhost:8080\/swagger-ui\/<\/code> aufgerufen werden.<\/p>\n\n\n\nOpenAPI Generator<\/h4>\n\n\n\n
Verwendung des OpenAPI Generators<\/h5>\n\n\n\n
openapi.yaml<\/code>-Datei, die unsere API beschreibt. Mit dem folgenden Befehl kann ein Spring Boot-Projekt generiert werden:<\/p>\n\n\nopenapi-generator-cli generate -i openapi.yaml -g spring -o .\/generated-spring-server<\/code><\/span><\/pre>\n\n\n-i<\/code> Parameter gibt die Eingabedatei an, -g<\/code> spezifiziert den gew\u00fcnschten Generator (in diesem Fall spring<\/code>), und -o<\/code> gibt das Ausgabeverzeichnis an.<\/p>\n\n\n\nPraktische Anwendung<\/h3>\n\n\n\n
Dokumentation<\/h4>\n\n\n\n
Codegenerierung<\/h4>\n\n\n\n
Validierung<\/h4>\n\n\n\n
Beispiel: Erstellung einer RESTful API mit OpenAPI und Spring Boot<\/h3>\n\n\n\n
Schritt 1: Projekt einrichten<\/h4>\n\n\n\n
pom.xml<\/code>:<\/p>\n\n\n<dependency<\/span>><\/span>\n <groupId<\/span>><\/span>org.springframework.boot<\/groupId<\/span>><\/span>\n <artifactId<\/span>><\/span>spring-boot-starter-web<\/artifactId<\/span>><\/span>\n<\/dependency<\/span>><\/span>\n<dependency<\/span>><\/span>\n <groupId<\/span>><\/span>io.springfox<\/groupId<\/span>><\/span>\n <artifactId<\/span>><\/span>springfox-boot-starter<\/artifactId<\/span>><\/span>\n <version<\/span>><\/span>3.0.0<\/version<\/span>><\/span>\n<\/dependency<\/span>><\/span><\/code><\/span>Code-Sprache:<\/span> HTML, XML<\/span> (<\/span>xml<\/span>)<\/span><\/small><\/pre>\n\n\nSchritt 2: API-Controller erstellen<\/h4>\n\n\n\n
import<\/span> org<\/span>.springframework<\/span>.web<\/span>.bind<\/span>.annotation<\/span>.GetMapping<\/span>;\nimport<\/span> org<\/span>.springframework<\/span>.web<\/span>.bind<\/span>.annotation<\/span>.RequestMapping<\/span>;\nimport<\/span> org<\/span>.springframework<\/span>.web<\/span>.bind<\/span>.annotation<\/span>.RestController<\/span>;\n\n@RestController<\/span>\n@RequestMapping(\"\/api\"<\/span>)\npublic class HelloWorldController {\n\n @GetMapping<\/span>(\"\/hello\")\n public String sayHello() {\n return<\/span> \"Hello<\/span>, World<\/span>!\";\n }\n}<\/code><\/span>Code-Sprache:<\/span> CSS<\/span> (<\/span>css<\/span>)<\/span><\/small><\/pre>\n\n\nSchritt 3: Swagger-Konfiguration hinzuf\u00fcgen<\/h4>\n\n\n\n
import<\/span> org<\/span>.springframework<\/span>.context<\/span>.annotation<\/span>.Bean<\/span>;\nimport<\/span> org<\/span>.springframework<\/span>.context<\/span>.annotation<\/span>.Configuration<\/span>;\nimport<\/span> springfox<\/span>.documentation<\/span>.builders<\/span>.RequestHandlerSelectors<\/span>;\nimport<\/span> springfox<\/span>.documentation<\/span>.spi<\/span>.DocumentationType<\/span>;\nimport<\/span> springfox<\/span>.documentation<\/span>.spring<\/span>.web<\/span>.plugins<\/span>.Docket<\/span>;\n\n@Configuration<\/span>\npublic class SwaggerConfig {\n\n @Bean<\/span>\n public Docket api() {\n return<\/span> new<\/span> Docket<\/span>(DocumentationType<\/span>.SWAGGER_2<\/span>)\n .select<\/span>()\n .apis<\/span>(RequestHandlerSelectors<\/span>.basePackage<\/span>(\"com<\/span>.example<\/span>.api<\/span>\"))\n .build<\/span>();\n }\n}<\/code><\/span>Code-Sprache:<\/span> CSS<\/span> (<\/span>css<\/span>)<\/span><\/small><\/pre>\n\n\nSchritt 4: OpenAPI-Dokumentation generieren<\/h4>\n\n\n\n
http:\/\/localhost:8080\/swagger-ui\/<\/code> auf, um die generierte Dokumentation zu sehen. Sie k\u00f6nnen die API-Endpunkte ausprobieren und die Dokumentation automatisch aktualisieren lassen.<\/p>\n\n\n\nFazit<\/h3>\n\n\n\n