Okay, auf dem
Bildschirm habe ich das GitHub-Konto für die OpenAPI-Spezifikation.
Hier befindet sich also der gesamte Quellcode der OpenAPI.
Es befindet sich in diesem GitHub-Repository.
Ich werde einen Link dazu in den Kursressourcen bereitstellen, so dass Sie direkt hierher gehen können.
Es gibt ein paar Dinge, die ich hier speziell für den Kurs, den wir uns ansehen
werden, hervorheben möchte. Wenn Sie hier reinkommen und einen Blick auf das Verzeichnis examples in GitHub werfen, können
Sie sehen, dass wir Version 2 haben. 0 und 3. 0.
Auch hier konzentriere ich mich nicht auf 2. 0, aber ich werde mir die 3. 0.
Hier eine Reihe von Beispielen.
Erinnern Sie sich daran, dass wir uns den Petstore angesehen haben, also hier ist der Petstore. YAML hat die OpenAPI-Spezifikation.
Wie Sie sehen können, gibt es mehrere verschiedene Implementierungen der OpenAPI-Spezifikation, die wir uns ansehen können.
Es gibt also ein paar wirklich gute Beispiele, wenn Sie sehen wollen, wie man etwas macht, können Sie
diese durchgehen und überprüfen, und lassen Sie uns hierher zurückgehen. Als Nächstes wollen wir uns die IMPLEMENTAIONS ansehen, diese
Markdown-Datei hier IMPLEMENTATIONS. Dies sind bekannte Implementierungen für OpenAPI3. 0.
Wir können sehen, dass es eine Reihe von Werkzeugen gibt, die in verschiedenen Programmen eingerichtet wurden, die verfügbar sind.
Diese Liste wird ständig erweitert. Ich kann nur empfehlen, sich damit zu beschäftigen, und es gibt verschiedene Technologien,
die verfügbar sind.
Da ich in erster Linie Java-Entwickler bin, finden Sie dort eine Reihe von Java-Tools.
Ich kann kaum Ruby buchstabieren, aber es gibt Ruby-Tools, Node. js, Typescript, PHP. Wir haben also eine große Anzahl von
Werkzeugen zur Verfügung.
Erinnern Sie sich, dass ich sagte, dass wir den SwaggerHub-Editor verwenden werden.
Hier finden Sie einige spezifische Tools für die Arbeit mit OpenAPI.
Einige spezielle Redakteure. Viele Leute mögen Visual Studio.
Ich habe tatsächlich diese hier an der Spitze verwendet Visual Studio Code-Erweiterung ist ganz nett. Sie sollten also lieber Sisual Studio
verwenden.
Es handelt sich um ein kostenloses Tool, das Sie als Leitartikel verwenden können.
Und ich weiß von einigen, die hier nicht verfügbar sind. Diese Liste ist also keineswegs vollständig, es gibt tatsächlich
noch weitere Werkzeuge, die nicht auf dieser Liste stehen.
Dann können Sie hier User Interfaces sehen.
Dies sind also Werkzeuge, die wir in die OpenAPI-Spezifikation aufnehmen und Ihnen eine Dokumentation zur Verfügung stellen.
Wir haben swagger-ui also bereits in Aktion gesehen.
Und hier sind einige zusätzliche Optionen.
Also Widdershins, das ist eine ziemlich beliebte.
Was die Erstellung von Endbenutzerdokumentation aus Ihrer OpenAPI-Spezifikation betrifft, so gefällt mir persönlich Redoc recht
gut.
Dies ist ein sehr nettes Tool zum Generieren von Benutzerdokumentation aus Ihrer OpenAPI-Spezifikation, und jetzt können Sie
auch sehen, dass wir Server-Implementierungen, Client-Implementierungen und Code-Generatoren haben.
Es gibt also eine Reihe verschiedener Codegeneratoren, die Sie mit der OpenAPI-Spezifikation verwenden können.
Lassen Sie uns hierher zurückgehen.
Und denken Sie daran, dass die OpenAPI-Spezifikation durch ein formales Schema unterstützt wird.
Hier ist das JSON-Schema.
Hier können Sie sich genau ansehen,
wie das OpenAPI-Schema definiert ist. Dies ist sozusagen der rohe Quellcode dafür, aber wir werden uns das
auf eine andere Art und Weise ansehen. Ich werde nicht zu tief in die Materie eindringen,
sondern hierher zurückkehren. Und schließlich empfehle ich, die Dokumentation durchzulesen, denn es gibt eine
Menge Dokumentation dazu.
Sie können sehen, Tools und Bibliotheken Beteiligung, wie es lizenziert ist, wenn Sie zu diesem Projekt beitragen wollen
es ist ein Open-Source-Projekt.
Es gibt sogar einen technischen Lenkungsausschuss, der Richtlinien entwickelt. Ich werde hier natürlich nicht alles
aufzählen, wir sprechen nur darüber, wie wir versuchen, OpenAPI zu erreichen, und Sie können hier sehen,
dass wir derzeit bei 3 sind. 0. 2.
Und wenn ich darauf klicke, führt mich dieser Link tatsächlich zu zwei Versionen.
Aber ich werde einfach weiterklicken und das anklicken.
Dies ist die Dokumentation für das OpenAPI-Schema, mit dem wir uns sehr gut vertraut machen werden.
Insbesondere werden wir uns mit der Entwicklung anhand des OpenAPI-Schemas befassen
und uns die Besonderheiten des OpenAPI-Objekts ansehen. Wie Sie hier sehen können, handelt es sich um die Schemaspezifikation der obersten
Ebene, die wir in den nächsten Videos durchgehen werden.
Diese Dokumentation hier für OpenAPI ist sehr umfangreich und detailliert und Sie sollten dieses Dokument als die
einzige Quelle der Wahrheit betrachten, wenn Sie mit OpenAPI-Dokumentation arbeiten.