So starten Sie die Swagger-Benutzeroberfläche und den Swagger-Editor in Docker

Was ist Swagger?

Swagger ist ein API-Konstruktionsframework, mit dem API-Dokumententwürfe und API-Mock-Anforderungen (Prototypen) erstellt werden können. Die diesmal verwendeten Swagger-Werkzeuge sind die folgenden drei.

Werkzeug	Erläuterung
Swagger Spec	(Spec = Specification = Specification) Dies ist ein Dokument, das sich auf die Spezifikationen von Swagger bezieht und YAML ist./Geschrieben im JSON-Format.
Swagger Editor	Ein Tool, mit dem Sie Swagger Spec-Dateien bearbeiten können, die im Browser ausgeführt werden, und die Syntax in Echtzeit überprüfen können.
Swagger UI	Ein Tool, das Dokumente dynamisch aus Swagger Spec generiert.

Weitere Swagger-bezogene Tools finden Sie auf der offiziellen Seite unter Link.

Über die Beziehung von Swagger-Werkzeugen

Zuerst habe ich versucht zu veranschaulichen, wie Swagger Editor und Swagger UI verwendet werden, wobei ich mich auf die Generierung von Swagger Spec-Dateien konzentrierte. Verwenden Sie als diesmal verwendetes Bild den Swagger-Editor, um SwaggerSpec zu bearbeiten und zu definieren. Dies ist die API-Spezifikation im Browser. Wenn Sie die Syntax bestätigen können, geben Sie sie in die eigentliche Yaml-Datei ein und verweisen Sie sie über die Swagger-Benutzeroberfläche Es ist ein Fluss.

スクリーンショット 2020-10-24 17.24.54.png

Verfahren

Einstellpunkt:

Setzen Sie docker-compose.yml, um Swagger Editor- und Swagger UI-Bilder zu erstellen.
Platzieren Sie die Swagger-Definition als "sample.yaml".

`docker-compose.yml`


version: '3.7'
services:
 swagger-editor:
    image: swaggerapi/swagger-editor
    ports:
      - "8001:8080"

  swagger-ui:
    image: swaggerapi/swagger-ui
    ports:
      - "8002:8080"
    volumes:
      - ./sample.yaml:/sample.yaml
    environment:
      SWAGGER_JSON: sample.yaml

`Verzeichnisaufbau`



├── docker-compose.yaml
└── sample.yaml

Gehen Sie im Terminal wie folgt vor:

`Terminal`


$ docker-compose up

Der Swagger-Editor beginnt um "https: // localhosst: 8001" und die Swagger-Benutzeroberfläche um "https: // localhost: 8002".

Recommended Posts

So starten Sie die Swagger-Benutzeroberfläche und den Swagger-Editor in Docker

Verwendung von Docker in VSCode DevContainer

Verstehe in 5 Minuten !! Wie man Docker benutzt

So rufen Sie Bibliotheken wie JQuery und JQuery UI in Liferay 7 / DXP auf

So überprüfen Sie das Protokoll im Docker-Container

So aktualisieren Sie eine vorgefertigte Datei in einem Docker-Container

So installieren Sie Docker

So starten Sie einen anderen Befehl in einem Ruby-Programm

So löschen Sie mit Docker Bilder ohne Tags in großen Mengen

So konvertieren Sie A in a und a in A mit logischem Produkt und Summe in Java

Umgang mit TSV-Dateien und CSV-Dateien in Ruby

So legen Sie Nginx von Docker fest

So trennen Sie Wörter in Namen in Klassen, Methoden und Variablen

[Forge] So registrieren Sie Ihre eigene Entität und Ihr Entity Render in 1.13.2

[Rails] So definieren Sie Makros in Rspec und standardisieren die Verarbeitung

So legen Sie den Zeichencode und den Zeilenvorschubcode in Eclipse fest

Was ist in "Java 8 bis Java 11" passiert und wie wird eine Umgebung erstellt?

Aufrufen und Verwenden der API in Java (Spring Boot)

Zeigen Sie die API-Definition in der Swagger-Benutzeroberfläche mit Docker + Rails6 + apipie an

Unterschiede im Umgang mit Zeichenfolgen zwischen Java und Perl

So installieren Sie PHP 7.4- und SQL Server-Treiber in CentOS 7.7

So ändern Sie die Hintergrundfarbe der Navigationsleiste usw. in der Swift-Benutzeroberfläche

So fügen Sie PKCE Code_Verifier und Code_Challenge in die JMeter-Anforderung ein

So erstellen und starten Sie eine Docker-Datei für Payara Micro

So wechseln Sie in Netty dynamisch zwischen FIN und RST

Wie man Lombok im Frühling benutzt

Verwendung von StringBurrer und Arrays.toString.

So finden Sie May'n in XPath

So blenden Sie die Bildlaufleiste in WebView aus

Verwendung von EventBus3 und ThreadMode

Wie man in Ruby auf unbestimmte Zeit iteriert

Wie man Ant in Gradle ausführt

Wie man die Programmierung in 3 Monaten beherrscht

Wie POST JSON in Java-Methode mit OkHttp3 und Methode mit HttpUrlConnection-

[Webpacker] Zusammenfassung der Installation von Bootstrap und jQuery in Rails 6.0

So führen Sie JavaFX unter Docker aus

Wie man JAVA in 7 Tagen lernt

Aufrufen von Klassen und Methoden

Wie man Gleichheit und Gleichheit benutzt (wie man Gleichheit benutzt)

So installieren Sie Bootstrap in Ruby

So legen Sie ein Profil mit annotationsbasierter Konfiguration im Spring-Framework fest und verwenden es

So verbinden Sie Heroku und Sequel

Verwendung von InjectorHolder in OpenAM

[jOOQ] Wie in der WHERE / AND / OR-Klausel WANN FALLEN

So löschen Sie große Datenmengen in Rails und Bedenken

So installieren Sie jQuery in Rails 6

Wie verwende ich Klassen in Java?

So benennen Sie Variablen in Java

Abrufen und Hinzufügen von Daten aus dem Firebase Firestore in Ruby

So setzen Sie Lombok in Eclipse

Fordern Sie die Installation von WSL2 und Docker heraus

So erstellen Sie CloudStack mit Docker

So starten Sie Camunda mit Docker

So verketten Sie Zeichenfolgen mit Java