suchen
HeimBackend-EntwicklungGolangÖffnen Sie API-Spezifikationen mit mehr als einer YAML-Datei

Open API specs with more than one YAML file

Jeder, der jemals eine REST-API dokumentiert hat, weiß, wie es sich anfühlt, eine ganze YAML-Datei mit all diesen Ressourcen, Pfaden, Anforderungen und Schemata zu schreiben, aber plötzlich merkt man, dass man eine behält Datei, in der die letzte Zeile 5 Ziffern lang ist. Ja, es ist schmerzhaft.

Da die besten Anwendungen diejenigen sind, die wir selbst entwickelt haben, befand ich mich genau an dieser Stelle und dokumentierte eine API bei der Arbeit. Ich habe viel gesucht, aber keine einzige praktikable Lösung für dieses Problem gefunden. Da kommen unsere Programmierinstinkte ins Spiel und wir verbringen fünfmal so viel Zeit damit, ein neues Werkzeug für uns selbst zu bauen. Genau das habe ich getan und möchte Ihnen allen ein brandneues, in Go geschriebenes Tool vorstellen, mit dem Sie Ihre YAML-Dateien in einer einzigen Boss-Datei zusammenführen können, um sie als Ihre OpenAPI-Spezifikation zu verwenden.

Wir stellen vor: GOpenAPI

GOpenAPI (Golang OpenAPI) ist ein Tool, das eine Datei namens dirs.json verwendet, um Dateien und Verzeichnisse (ja, ganze Verzeichnisse im Yaml-Format) am Ende der Ausführung in eine einzige swagger.yaml-Datei zu scannen.

Sie können den Quellcode hier überprüfen. Beachten Sie, dass das Repository auch eine Vorlage ist, die geklont und als Entwurf verwendet werden kann, um mit diesem Tool Ihre erste OpenAPI-Spezifikation zu erstellen (stellen Sie nur sicher, dass Sie den Gopenapi-Ordner behalten, wenn Sie nicht bereit sind, ihn über go install zu installieren, andernfalls ist er vollständig abnehmbar)

Wie funktioniert es (und bekomme ich es zum Laufen)?

Einfach: Sobald Sie gopenapi ausführen, liest es die Datei dirs.json und beginnt mit der Erstellung einer OpenAPI-Spezifikation mit allen darin deklarierten Dateien und Ordnern. Beachten Sie, dass dirs.json Dateien für eindeutige Schlüssel wie Informationen, Server und Sicherheit sowie einen Schlüssel namens „Template“ verwendet (bei dem es sich nur um eine leere OpenAPI-YAML-Datei handelt)

Ressourcen und Schlüssel, die schwer in einer einzigen Datei gespeichert werden können (z. B. Pfade, Schemata und Anforderungen), können in Ordnern gespeichert werden, und diese können auch mit dem gemeinsamen #ref-Tag auf OpenAPI erwähnt werden, da dies bei allen der Fall ist Gehen Sie nach dem Zusammenführen zur gleichen Datei.

Dieses Projekt verfügt außerdem über eine index.html, die statisch bereitgestellt werden kann und außerdem mit dem offiziellen Swagger UI-Bundle interagiert, das im dist-Ordner enthalten ist.

Das ist alles, Leute

Ich hoffe, dass dieses Tool für jeden geeignet ist, der (genau wie ich) viele Reddits- und Github-Repositories durchsucht hat, nur um nicht das gesuchte Tool zu finden. Nun, jetzt haben Sie es und es ist völlig Open Source, was bedeutet, dass ich, wenn Sie eine Verbesserung oder ein Problem sehen, das gelöst werden kann, nicht zweimal darüber nachdenken werde, mit Ihnen zusammenzuarbeiten, um es zu lösen. Außerdem bin ich ziemlich naiv, was Golang angeht, daher könnte es bei diesem Projekt viel zu verbessern geben. Ich werde versuchen, es auf dem neuesten Stand zu halten und es ständig zu verbessern (da ich es jetzt auch häufig verwenden werde)

Vielen Dank fürs Lesen und ich hoffe, dass es Ihnen genauso nützlich ist wie mir ;)

Das obige ist der detaillierte Inhalt vonÖffnen Sie API-Spezifikationen mit mehr als einer YAML-Datei. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!

Stellungnahme
Der Inhalt dieses Artikels wird freiwillig von Internetnutzern beigesteuert und das Urheberrecht liegt beim ursprünglichen Autor. Diese Website übernimmt keine entsprechende rechtliche Verantwortung. Wenn Sie Inhalte finden, bei denen der Verdacht eines Plagiats oder einer Rechtsverletzung besteht, wenden Sie sich bitte an admin@php.cn
GO Language Pack Import: Was ist der Unterschied zwischen Unterstrich und ohne Unterstrich?GO Language Pack Import: Was ist der Unterschied zwischen Unterstrich und ohne Unterstrich?Mar 03, 2025 pm 05:17 PM

Dieser Artikel erläutert die Paketimportmechanismen von Go: benannte Importe (z. B. importieren & quot; fmt & quot;) und leere Importe (z. B. Import _ & quot; fmt & quot;). Benannte Importe machen Paketinhalte zugänglich, während leere Importe nur T ausführen

Wie kann ich kurzfristige Informationsübertragung zwischen Seiten im BeEGO-Framework implementieren?Wie kann ich kurzfristige Informationsübertragung zwischen Seiten im BeEGO-Framework implementieren?Mar 03, 2025 pm 05:22 PM

In diesem Artikel werden die Newflash () -Funktion von BeEGO für die Übertragung zwischen PAGE in Webanwendungen erläutert. Es konzentriert sich auf die Verwendung von Newflash (), um temporäre Nachrichten (Erfolg, Fehler, Warnung) zwischen den Controllern anzuzeigen und den Sitzungsmechanismus zu nutzen. Limita

Wie konvertieren Sie die Liste der MySQL -Abfrageergebnisse in eine benutzerdefinierte Struktur -Slice in Go -Sprache?Wie konvertieren Sie die Liste der MySQL -Abfrageergebnisse in eine benutzerdefinierte Struktur -Slice in Go -Sprache?Mar 03, 2025 pm 05:18 PM

Dieser Artikel beschreibt die effiziente Konvertierung von MySQL -Abfrageergebnissen in GO -Strukturscheiben. Es wird unter Verwendung der SCAN -Methode von Datenbank/SQL zur optimalen Leistung hervorgehoben, wobei die manuelle Parsen vermieden wird. Best Practices für die Struktur -Feldzuordnung mithilfe von DB -Tags und Robus

Wie schreibe ich Scheinobjekte und Stubs zum Testen in Go?Wie schreibe ich Scheinobjekte und Stubs zum Testen in Go?Mar 10, 2025 pm 05:38 PM

Dieser Artikel zeigt, dass Mocks und Stubs in GO für Unit -Tests erstellen. Es betont die Verwendung von Schnittstellen, liefert Beispiele für Mock -Implementierungen und diskutiert Best Practices wie die Fokussierung von Mocks und die Verwendung von Assertion -Bibliotheken. Die Articl

Wie kann ich benutzerdefinierte Typ -Einschränkungen für Generika in Go definieren?Wie kann ich benutzerdefinierte Typ -Einschränkungen für Generika in Go definieren?Mar 10, 2025 pm 03:20 PM

In diesem Artikel werden die benutzerdefinierten Typ -Einschränkungen von GO für Generika untersucht. Es wird beschrieben, wie Schnittstellen die minimalen Typanforderungen für generische Funktionen definieren und die Sicherheitstypsicherheit und die Wiederverwendbarkeit von Code verbessern. Der Artikel erörtert auch Einschränkungen und Best Practices

Wie schreibe ich Dateien in Go Language bequem?Wie schreibe ich Dateien in Go Language bequem?Mar 03, 2025 pm 05:15 PM

Dieser Artikel beschreibt effizientes Dateischreiben in Go und vergleicht OS.WriteFile (geeignet für kleine Dateien) mit OS.openfile und gepufferter Schreibvorgänge (optimal für große Dateien). Es betont eine robuste Fehlerbehandlung, die Verwendung von Aufschub und Überprüfung auf bestimmte Fehler.

Wie schreibt man Unit -Tests in Go?Wie schreibt man Unit -Tests in Go?Mar 21, 2025 pm 06:34 PM

In dem Artikel werden Schreiben von Unit -Tests in GO erörtert, die Best Practices, Spottechniken und Tools für ein effizientes Testmanagement abdecken.

Wie kann ich Tracing -Tools verwenden, um den Ausführungsfluss meiner GO -Anwendungen zu verstehen?Wie kann ich Tracing -Tools verwenden, um den Ausführungsfluss meiner GO -Anwendungen zu verstehen?Mar 10, 2025 pm 05:36 PM

In diesem Artikel wird die Verwendung von Tracing -Tools zur Analyse von GO -Anwendungsausführungsfluss untersucht. Es werden manuelle und automatische Instrumentierungstechniken, den Vergleich von Tools wie Jaeger, Zipkin und Opentelemetrie erörtert und die effektive Datenvisualisierung hervorheben

See all articles

Heiße KI -Werkzeuge

Undresser.AI Undress

Undresser.AI Undress

KI-gestützte App zum Erstellen realistischer Aktfotos

AI Clothes Remover

AI Clothes Remover

Online-KI-Tool zum Entfernen von Kleidung aus Fotos.

Undress AI Tool

Undress AI Tool

Ausziehbilder kostenlos

Clothoff.io

Clothoff.io

KI-Kleiderentferner

AI Hentai Generator

AI Hentai Generator

Erstellen Sie kostenlos Ai Hentai.

Heißer Artikel

Heiße Werkzeuge

MantisBT

MantisBT

Mantis ist ein einfach zu implementierendes webbasiertes Tool zur Fehlerverfolgung, das die Fehlerverfolgung von Produkten unterstützen soll. Es erfordert PHP, MySQL und einen Webserver. Schauen Sie sich unsere Demo- und Hosting-Services an.

PHPStorm Mac-Version

PHPStorm Mac-Version

Das neueste (2018.2.1) professionelle, integrierte PHP-Entwicklungstool

VSCode Windows 64-Bit-Download

VSCode Windows 64-Bit-Download

Ein kostenloser und leistungsstarker IDE-Editor von Microsoft

Notepad++7.3.1

Notepad++7.3.1

Einfach zu bedienender und kostenloser Code-Editor

Herunterladen der Mac-Version des Atom-Editors

Herunterladen der Mac-Version des Atom-Editors

Der beliebteste Open-Source-Editor