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 |
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/ |
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