Resolve and validate OpenAPI specs with remote refs before client generation or review with Prance
Validate an OpenAPI document, resolve external references, and emit a clean compiled spec before codegen or contract review.
Prerequisites
Python, pip, OpenAPI or Swagger spec file or URL
Installation
Use the upstream install or setup path that matches your environment:
- $ pip install prance
- $ pip install prance[osv,icu,cli]
- Make sure you have ICU Unicode Library http://site.icu-project.org/home__ installed,
- $ pip install openapi-spec-validator
Requirements and caveats from upstream:
- |License| |PyPI| |Python Versions| |Package Format| |Package Status|
- 2.0 and 3.0 http://swagger.io/specification/__ API specifications in Python.
- with providing relative file paths, whereas JSON references require URIs
Basic usage or getting-started notes:
- =====
Prance is available from PyPI, and can be installed via pip:
Extracted from upstream docs: https://raw.githubusercontent.com/RonnyPfannschmidt/prance/HEAD/README.rst