Contenu

Pour améliorer l'efficacité du développement de l'API REST, je pense que des outils seront utilisés pour la génération de spécifications, la génération de code, la vérification de style et le formatage automatique.
Pour Python, voici quelques outils que je trouve utiles.
L'éditeur de développement est VSCode.

Lié à l'API REST

Ecrivez la spécification OpenAPI au format yaml et générez la spécification et le code de l'interface API REST.
Spécifications de l'interface
Stub côté serveur (contrôleur, modèle de requête / réponse HTTP)
SDK client pour l'API REST frontale
La génération d'un stub de serveur est très pratique.
Si vous générez du code Flask en Python, vous pouvez même contrôler une application Flask (enveloppée dans une bibliothèque appelée connexion) qui contrôle les requêtes HTTP basées sur la spécification OpenAPI.
Puisqu'il valide les requêtes HTTP en fonction de la spécification OpenAPI, vous n'avez pas besoin de développer vous-même le code de validation.
Pour le côté client, il peut également être utilisé comme serveur stub jusqu'à ce que le côté serveur soit terminé.
Le SDK client est également utile. C'est plus facile que de créer vos propres points de terminaison et requêtes.
Les outils utilisés sont les suivants.

Utilisation	Nom de l'outil	Explication	Lien
Modification de la spécification OpenAPI	VSCode + OpenAPI Editor(Extension)	Écrivez la spécification OpenAPI sur VSCode. Il est pratique d'avoir un tableau des chemins et des schémas sur le côté gauche.	https://marketplace.visualstudio.com/items?itemName=42Crunch.vscode-openapi
Référence aux spécifications OpenAPI	VSCode + Swagger Viewer(Extension)	Vous pouvez vous référer à la spécification OpenAPI en tant que document.	https://marketplace.visualstudio.com/items?itemName=Arjun.swagger-viewer
Validation des spécifications OpenAPI	openapi-generator	CLIでValidation des spécifications OpenAPIができます。 Vous pouvez également détecter des erreurs que l'éditeur OpenAPI ne peut pas détecter. Cependant, certains bugs ne peuvent toujours pas être détectés. Par exemple, l'élément défini sur requis dans le schéma n'est pas réellement défini comme une propriété. Je remarque ces choses parce que j'obtiens une erreur lorsque je code le stub du serveur et le démarre.	https://github.com/OpenAPITools/openapi-generator
Génération de code	openapi-generator	OpenAPI仕様（yamlファイル）からGénération de code（サーバースタブ、クライアントSDK）できます。	Comme ci-dessus
Génération de documents	openapi-genrator	Générez les spécifications d'interface de l'API REST au format HTML.	Comme ci-dessus

Générer un diagramme de classes et des spécifications de classe à partir du code développé.
Vous devez écrire une docstring comme prérequis pour générer une spécification de classe.
Linter (vérification de style) et Formatter (format automatique) sont également utiles pour le développement de code.
Les outils utilisés sont les suivants.

Utilisation	Nom de l'outil	Explication	Lien
Génération de diagramme de classes	Pyreverse	Génération de diagrammes de classes	https://pypi.org/project/pylint/
Génération de spécifications de classe	Sphinx	Génération de spécification de classe	https://www.sphinx-doc.org/ja/master/ Procédure d'installation de Sphinx
aide à la description docstring	VSCode + Python Docstring Generator	Vous pouvez générer un modèle docstring à partir de votre code. Par exemple, dans le cas d'une méthode, la ligne de résumé, le nom de l'argument, le type et le type de retour sont générés à partir du code, vous pouvez donc simplement écrire la description vous-même.	https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring
Vérification du style Python	VSCode + flake8	Il vérifiera s'il est conforme à pep8 et affichera le résultat.	https://pypi.org/project/flake8/
Format automatique Python	VSCode + autopep8	Dans une certaine mesure, il modifiera automatiquement le code pour qu'il soit conforme à pep8. Par exemple, ouvrez une ligne vierge de deux lignes au-dessus de la définition de classe ou placez un espace demi-largeur dans l'argument.	https://pypi.org/project/autopep8/

Dans le développement de code, DB est utilisé dans de nombreux cas.
Je vais présenter un outil pratique qui peut générer un diagramme ER, une définition de table et DDL avec GUI.
Plug-in Eclipse ERMaster.
Si vous écrivez un diagramme ER avec GUI, vous pouvez générer des spécifications de tableau Excel et des instructions DDL à partir de celui-ci.
Je pense qu'il vaut mieux écrire le modèle de données conceptuel dans Powerpo ou draw.io, et l'écrire dans ERMaster à partir du modèle de données logique.

Utilisation	Nom de l'outil	Explication	Lien
Diagramme ER, définition de table, génération DDL	ERMaster	Eclipseのプラグインで、GUIで、Diagramme ER, définition de table, génération DDLができます。	http://ermaster.sourceforge.net/index_ja.html