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
Was sind die Schwachstellen von Debian OpenenslWas sind die Schwachstellen von Debian OpenenslApr 02, 2025 am 07:30 AM

OpenSSL bietet als Open -Source -Bibliothek, die in der sicheren Kommunikation weit verbreitet sind, Verschlüsselungsalgorithmen, Tasten und Zertifikatverwaltungsfunktionen. In seiner historischen Version sind jedoch einige Sicherheitslücken bekannt, von denen einige äußerst schädlich sind. Dieser Artikel konzentriert sich auf gemeinsame Schwachstellen und Antwortmaßnahmen für OpenSSL in Debian -Systemen. DebianopensL Bekannte Schwachstellen: OpenSSL hat mehrere schwerwiegende Schwachstellen erlebt, wie z. Ein Angreifer kann diese Sicherheitsanfälligkeit für nicht autorisierte Lesen sensibler Informationen auf dem Server verwenden, einschließlich Verschlüsselungsschlüssel usw.

Wie verwenden Sie das PPROF -Tool, um die Go -Leistung zu analysieren?Wie verwenden Sie das PPROF -Tool, um die Go -Leistung zu analysieren?Mar 21, 2025 pm 06:37 PM

In dem Artikel wird erläutert, wie das PPROF -Tool zur Analyse der GO -Leistung verwendet wird, einschließlich der Aktivierung des Profils, des Sammelns von Daten und der Identifizierung gängiger Engpässe wie CPU- und Speicherprobleme.Character Count: 159

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 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

Erläutern Sie den Zweck von Go's Reflect Package. Wann würden Sie Reflexion verwenden? Was sind die Leistungsauswirkungen?Erläutern Sie den Zweck von Go's Reflect Package. Wann würden Sie Reflexion verwenden? Was sind die Leistungsauswirkungen?Mar 25, 2025 am 11:17 AM

In dem Artikel wird das Reflect -Paket von Go, das zur Laufzeitmanipulation von Code verwendet wird, von Vorteil für die Serialisierung, generische Programmierung und vieles mehr. Es warnt vor Leistungskosten wie langsamere Ausführung und höherer Speichergebrauch, beraten die vernünftige Verwendung und am besten am besten

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

Wie verwenden Sie tabelgesteuerte Tests in Go?Wie verwenden Sie tabelgesteuerte Tests in Go?Mar 21, 2025 pm 06:35 PM

In dem Artikel werden mit Tabellensteuerungstests in GO eine Methode mit einer Tabelle mit Testfällen getestet, um Funktionen mit mehreren Eingaben und Ergebnissen zu testen. Es zeigt Vorteile wie eine verbesserte Lesbarkeit, verringerte Vervielfältigung, Skalierbarkeit, Konsistenz und a

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ße Werkzeuge

Notepad++7.3.1

Notepad++7.3.1

Einfach zu bedienender und kostenloser Code-Editor

ZendStudio 13.5.1 Mac

ZendStudio 13.5.1 Mac

Leistungsstarke integrierte PHP-Entwicklungsumgebung

SAP NetWeaver Server-Adapter für Eclipse

SAP NetWeaver Server-Adapter für Eclipse

Integrieren Sie Eclipse mit dem SAP NetWeaver-Anwendungsserver.

mPDF

mPDF

mPDF ist eine PHP-Bibliothek, die PDF-Dateien aus UTF-8-codiertem HTML generieren kann. Der ursprüngliche Autor, Ian Back, hat mPDF geschrieben, um PDF-Dateien „on the fly“ von seiner Website auszugeben und verschiedene Sprachen zu verarbeiten. Es ist langsamer und erzeugt bei der Verwendung von Unicode-Schriftarten größere Dateien als Originalskripte wie HTML2FPDF, unterstützt aber CSS-Stile usw. und verfügt über viele Verbesserungen. Unterstützt fast alle Sprachen, einschließlich RTL (Arabisch und Hebräisch) und CJK (Chinesisch, Japanisch und Koreanisch). Unterstützt verschachtelte Elemente auf Blockebene (wie P, DIV),

SecLists

SecLists

SecLists ist der ultimative Begleiter für Sicherheitstester. Dabei handelt es sich um eine Sammlung verschiedener Arten von Listen, die häufig bei Sicherheitsbewertungen verwendet werden, an einem Ort. SecLists trägt dazu bei, Sicherheitstests effizienter und produktiver zu gestalten, indem es bequem alle Listen bereitstellt, die ein Sicherheitstester benötigen könnte. Zu den Listentypen gehören Benutzernamen, Passwörter, URLs, Fuzzing-Payloads, Muster für vertrauliche Daten, Web-Shells und mehr. Der Tester kann dieses Repository einfach auf einen neuen Testcomputer übertragen und hat dann Zugriff auf alle Arten von Listen, die er benötigt.