Ich habe versucht, API list.csv mit Python aus swagger.yaml zu erstellen

Umgebung

Übrigens habe ich zum ersten Mal einen Artikel über Qiita geschrieben.

Annahme

MacBook Pro macOS Catalina 10.15.7

Einführung

Ich habe folgendes installiert.

1. Docker

• Visual Studio Code
• Visual Studio Code-Erweiterung
  1. Japanese Language Pack
  • Docker 1.6.0
  • Remote - Containers 0.145.0
  • Python
  • PyLint
  • Rainbow CSV 1.7.1
  • YAML 0.11.1
  • Swagger Viewer 3.0.1
  • OpenAPI (Swagger) Editor 3.7.0

Referenz:

• Lesezeichen, das den Link zur geöffneten Webseite im Markdown-Format - Qiita kopiert
• So erstellen Sie eine Python-Entwicklungsumgebung mit Docker anstelle von VM [Mac] | Laplace

Aufbau

1. Aktivieren Sie die VS-Code-Synchronisierungseinstellungen

• Arbeitsordner erstellen (in Dropbox erstellt)
• Öffnen Sie Ihren Arbeitsordner mit VS Code

Arbeit

1. Erstellen Sie ein Repository auf Github
2. Kopieren Sie zur Hand microsoft / vscode-remote-try-python (Git-Klon)
3. Ändern Sie das Remote-Ziel in Ihr Repository mit dem Ordnernamen und der Git-Remote-Set-URL

Fehlerbehandlung

Ich habe einen Fehler bei der Installation der Bibliothek oder bei der Verwendung von Jupiter erhalten. Vorerst habe ich einen Kommentar abgegeben, um den Benutzer als root zu belassen.

Bibliotheksinstallation

Verwenden Sie die PyYAML-Bibliothek und die CSV-Bibliothek. Es ist sehr einfach und wunderbar, weil Sie es einfach in require.txt schreiben und neu erstellen und erneut ausführen.

requirements.txt

flask
pyyaml
csv
ipykernel

Codierung

Öffnen Sie Yaml, Sammeln Sie die Inhalte, die Sie in der Reihenfolge in CSV schreiben möchten. Als CSV speichern erreicht.

Da yaml als Wörterbuchtyp gelesen wird, Es ging darum, die Schleifen- und Variablenerfassung so zu beschreiben, dass sie die gewünschten Bedingungen erfüllen.

open-api-yaml-to-csv.py

import yaml
import csv

#Speichern Sie den Inhalt der yaml-Datei in einer Variablen vom Typ Wörterbuch
with open("oidc-swagger.yaml", "r") as yf:
    data = yaml.safe_load(yf)

#Extrahieren Sie die erforderlichen Informationen aus dem Wörterbuch und speichern Sie sie als Array
api_list_array = []
i = 0
api_list_array.append(["#", "operationId", "METHOD", "PATH"])
for path in data['paths'].keys():
    if path != "/swagger":
        for verb in data['paths'][path].keys():
            # if 'operationId' in data['paths'][path][verb]:
            name = data['paths'][path][verb]['operationId']
            i = i+1
            # print(i,name, verb, path)
            api_list_array.append([i, name, verb, path])

#Speichern Sie das Array als CSV
with open('list.csv', 'w') as csvfile:
    writer = csv.writer(csvfile)
    writer.writerows(api_list_array)

Dies war mein erster Beitrag. Es fiel mir schwer, die Umgebung aufzubauen, deshalb werde ich noch ein bisschen mehr hinzufügen.