Specification generation and code generation in REST API development (Python edition)

Contents

image.png

REST API related

Use Tool name Explanation Link
Editing OpenAPI Specification VSCode + OpenAPI Editor(Extensions) Write OpenAPI Specification on VSCode. It is convenient to have a table of contents for paths and schemas on the left side. https://marketplace.visualstudio.com/items?itemName=42Crunch.vscode-openapi
Reference to OpenAPI Specification VSCode + Swagger Viewer(Extensions) You can refer to the OpenAPI Specification as a document. https://marketplace.visualstudio.com/items?itemName=Arjun.swagger-viewer
Validation of OpenAPI Specification openapi-generator CLIでValidation of OpenAPI Specificationができます。
You can also detect errors that the OpenAPI Editor cannot detect. However, there are some bugs that cannot be detected even with this. For example, the item set to required in the schema is not actually defined as a property. I notice these things because I get an error when I code-generate the server stub and start it.
https://github.com/OpenAPITools/openapi-generator
Code generation openapi-generator OpenAPI仕様(yamlファイル)からCode generation(サーバースタブ、クライアントSDK)できます。 Same as above
Document generation openapi-genrator Generate REST API interface specifications in HTML format. Same as above

Python related

Use Tool name Explanation Link
Generation class diagram Pyreverse Class diagram generation https://pypi.org/project/pylint/
Generation of class specifications Sphinx Class specification generation https://www.sphinx-doc.org/ja/master/
Sphinx installation instructions
docstring description assistance VSCode + Python Docstring Generator You can generate a docstring template from your code. For example, in the case of a method, the summary line, argument name, type, and return type are generated from the code, so you can just write the description yourself. https://marketplace.visualstudio.com/items?itemName=njpwerner.autodocstring
Python style check VSCode + flake8 It will check if it conforms to pep8 and display the result. https://pypi.org/project/flake8/
Python automatic format VSCode + autopep8 To some extent, it will automatically modify the code to be pep8 compliant. For example, open two blank lines above the class definition, or put a space in the argument. https://pypi.org/project/autopep8/

DB related

Use Tool name Explanation Link
ER diagram, table definition, DDL generation ERMaster Eclipseのプラグインで、GUIで、ER diagram, table definition, DDL generationができます。 http://ermaster.sourceforge.net/index_ja.html

Recommended Posts

Specification generation and code generation in REST API development (Python edition)
Development and deployment of REST API in Python using Falcon Web Framework
Quickly implement REST API in Python
Operate Jupyter with REST API to extract and save Python code
[WP REST API v2] Upload images in Python
Try using ChatWork API and Qiita API in Python
Evernote API in Python
Framework development in Python
Development environment in Python
Slackbot development in Python
Get LEAD data using Marketo's REST API in Python
Hit Mastodon's API in Python
Python 2 series and 3 series (Anaconda edition)
Create code that outputs "A and pretending B" in python
Stack and Queue in Python
Generate QR code in Python
Predict gender from name using Gender API and Pykakasi in Python
Blender Python API in Houdini (Python 3)
[Tips] Problems and solutions in the development of python + kivy
Unittest and CI in Python
UpNext2 Development Record # 1 Build Python CI environment in VS Code
Python development in Visual Studio
Character code learned in Python
Cloud DevOps Cookbook Part 4-Explore DevOps DirectMail in Python with REST API
Firebase Authentication token issuance in Python and token verification with Fast API
Create a simple Python development environment with VS Code and Docker
[Python] I wrote a REST API using AWS API Gateway and Lambda.
[Pytest] [mock] Web development beginners summarized unit test and mock in python.
[SEO] Flow / sample code when using Google Analytics API in Python
LINE BOT (Messaging API) development with API Gateway and Lambda (Python) [Part 2]
MIDI packages in Python midi and pretty_midi
Getting the arXiv API in Python
Difference between list () and [] in Python
Difference between == and is in python
View photos in Python and html
Sorting algorithm and implementation in Python
Hit the Sesami API in Python
Web application development memo in python
Automatically format Python code in Vim
Manipulate files and folders in Python
About dtypes in Python and Cython
Assignments and changes in Python objects
Cooperation between python module and API
[Code] Module and Python version output
Create Gmail in Python without API
Ciphertext in Python: IND-CCA2 and RSA-OAEP
Write selenium test code in python
Hashing data in R and Python
Hit the web API in Python
Function synthesis and application in Python
Export and output files in Python
Python dummy data generation (address edition)
Password generation in texto with python
Reverse Hiragana and Katakana in Python2.7
Reading and writing text in Python
[GUI in Python] PyQt5-Menu and Toolbar-
Access the Twitter API in Python
Code tests around time in Python
Create and read messagepacks in Python
REST API of model made with Python with Watson Machine Learning (CP4D edition)
python> Copy and paste code> SyntaxError: Non-ASCII character'\ xe3' in file>-*-coding: utf-8-*-Add