{"repo":"Neoteroi/essentials-openapi","free":true,"listed":false,"github":"https://github.com/Neoteroi/essentials-openapi","clone":"git clone https://github.com/Neoteroi/essentials-openapi.git","description":"Functions to handle OpenAPI Documentation.","language":"Python","stars":30,"topics":["openapi","swagger","documentation","documentation-generator"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"essentials-openapi Classes to generate OpenAPI Documentation v3 and v2, in JSON and YAML, and to generate other kinds of documents from OpenAPI Documentation files. To install with dependencies to generate other kinds of artifacts from source OpenAPI Documentation files: Useful links https://swagger.io/specification/ https://editor.swagger.io Usage This library has been originally created to implement generation of OpenAPI Documentation in the BlackSheep web framework. However, this package is abstracted from that web framework and can be reused for other applications. Today this library also offers functions to generate documentation from source OpenAPI Documentation files. Features to generate artifacts from Open API Documentation These require the full package: install it using pip install essentials-openapi[full] . To generate output for MkDocs and PyMdown extentions: Example of MkDocs documentation generated using Neoteroi/mkdocs-plugins. --- To generate a PlantUML class diagram of the components schemas: Example of PlantUML diagram generated from components schemas. --- To generate a PlantUML class diagram with an overview of API endpoints: Example of PlantUML diagram generated from path items. Using custom templates You can override the default templates by providing a custom templates directory: The custom templates directory should contain template files with the same names as the built-in templates. Any template file found in the custom directory will override the c","default_branch":null,"files":null,"tree":[],"storefront":"/r/Neoteroi","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/Neoteroi/essentials-openapi/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}