J'ai essayé de créer une API list.csv avec Python à partir de swagger.yaml

Environnement

Au fait, j'ai écrit un article sur Qiita pour la première fois.

supposition

MacBook Pro macOS Catalina 10.15.7

introduction

J'ai installé ce qui suit.

1. Docker

• Visual Studio Code
• Extension Visual Studio Code
  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

référence:

• Bookmarklet pour copier le lien vers la page Web ouverte au format Markdown --Qiita
• Comment créer un environnement de développement Python avec Docker au lieu de VM [Mac] | Laplace

Réglage

1. Activer les paramètres de synchronisation VS Code

• Créer un dossier de travail (créé dans dropbox)
• Ouvrez votre dossier de travail avec VS Code

travail

1. Créez un référentiel sur Github
2. À portée de main, copiez microsoft / vscode-remote-try-python (git clone)
3. Changez la destination distante en votre propre référentiel avec le nom du dossier et git remote set-url

La gestion des erreurs

J'ai eu une erreur lors de l'installation de la bibliothèque ou de l'utilisation de Jupiter. Pour le moment, j'ai fait un commentaire pour laisser l'utilisateur root.

Installation de la bibliothèque

Utilisez la bibliothèque PyYAML et la bibliothèque CSV. C'est très facile et merveilleux car il suffit de l'écrire dans requirements.txt et de le reconstruire et de le relancer.

requirements.txt

flask
pyyaml
csv
ipykernel

codage

Ouvrez yaml, Rassemblez les contenus que vous souhaitez écrire en CSV dans l'ordre Enregistrer au format CSV accompli.

Puisque yaml est lu comme un type de dictionnaire, Il s'agissait de décrire la boucle et l'acquisition des variables afin qu'elles répondent aux conditions souhaitées.

open-api-yaml-to-csv.py

import yaml
import csv

#Stocker le contenu du fichier yaml dans une variable de type dictionnaire
with open("oidc-swagger.yaml", "r") as yf:
    data = yaml.safe_load(yf)

#Extraire les informations nécessaires du dictionnaire et les stocker sous forme de tableau
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])

#Enregistrez le tableau au format CSV
with open('list.csv', 'w') as csvfile:
    writer = csv.writer(csvfile)
    writer.writerows(api_list_array)

C'était mon premier message. J'ai eu du mal à créer l'environnement, je vais donc en ajouter un peu plus.