openapi3-parser 0.0.3

OpenAPI v3 parser

OpenAPI Parser

A simple package to parse your OpenAPI 3 documents into Python object to work with.

How to install

To install package run the following command

pip install openapi3-parser

How to use

Example of parser usage

>>> from openapi_parser import parse
>>> content = parse('swagger.yml')
>>> print(content)

Supported specification schemas

• Contact
• License
• Info
• Server
• ExternalDoc
• Tag
• Schema
• Integer schema
• Number schema
• String schema
• Array schema
• Object schema
• Property
• Parameter
• Header
• Content
• RequestBody
• Response
• Operation
• PathItem
• Path
• Security
• OAuthFlow
• Specification

Features

• OpenAPI's validation with openapi-spec-validator
• Parsing all the sections into Python dataclass
• Support many Enum values to simplify work with format, type, etc
• Auto-resolve $ref links with Prance
• Support custom x-* attributes
• Support automatic merge allOf schemas into one while resolving
• Support oneOf schemas
• Support anyOf schemas
• Support not schemas
• Support Parameter serialization style
• Support discriminator model types
• Support additional properties in dataclasses (like example, style, explode, etc). See TODOs in code
• Functions and methods documentation