{"categories":[{"label":"Documentation","url":"https://skillfed.io/packages/category/documentation/2"}],"enrichment":{"capability":"Generates OpenAPI v2 and v3 documentation in JSON and YAML formats, and converts OpenAPI files into MkDocs, Markdown, and PlantUML diagrams.","skillfed_tags":["openapi-tooling","api-documentation"],"use_cases":["Auto-generate OpenAPI specs from a web framework like BlackSheep and export them as JSON or YAML","Convert an existing OpenAPI file into MkDocs-compatible Markdown for publishing on a documentation site","Generate PlantUML class diagrams of API component schemas from an OpenAPI spec","Create PlantUML endpoint diagrams showing API paths and operations from an OpenAPI file","Build custom documentation output by overriding Jinja2 templates for a specific output style"],"what_it_does":"essentials-openapi is a Python library for working with OpenAPI specifications. It provides classes to generate OpenAPI v2 and v3 documentation in JSON and YAML formats from higher-level APIs, making it useful for web frameworks that want to auto-generate API docs. It also reads existing OpenAPI files (from local YAML/JSON or HTTP URLs) and converts them into other formats: Markdown for MkDocs, basic Markdown, or PlantUML diagrams showing either component schemas or API endpoint overviews.\n\nThe library depends on essentials, markupsafe, and pyyaml. It supports Python 3.10 through 3.14. The package explicitly does not aim to implement the full OpenAPI specification, nor does it validate OpenAPI files\u2014it assumes input comes from trusted sources. It offers a command-line tool (oad) for generation tasks and supports custom Jinja2 templates to override default output layouts.","worth_installing":"Yes. Low install friction, active maintenance, permissive license, no known vulnerabilities, and a focused scope make it a solid choice if you need to generate or transform OpenAPI documentation. Best suited for teams already using OpenAPI specs or frameworks that emit them; less relevant if you're hand-writing API docs or using a different spec format."},"id":"essentials-openapi","links":{"html":"https://skillfed.io/packages/essentials-openapi","md":"https://skillfed.io/packages/essentials-openapi.md","pypi":"https://pypi.org/project/essentials-openapi/"},"maintenance":{"status":"active"},"meta":{"latest_release":"2026-03-07","license_spdx":null,"license_treatment":"permissive","name":"essentials-openapi","python_support":"supports_current","summary":"Classes to generate OpenAPI Documentation v3 and v2, in JSON and YAML."},"popularity":{"monthly_downloads":189950,"position":9919,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"1.4.0"}