OpenAPI v3 parser
Project description
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)
Get application servers
from openapi_parser import parse
specification = parse('data/swagger.yml')
print("Application servers")
for server in specification.servers:
print(f"{server.description} - {server.url}")
# Output
#
# >> Application servers
# >> production - https://users.app
# >> staging - http://stage.users.app
# >> development - http://users.local
Get list of application URLs
from openapi_parser import parse
specification = parse('tests/data/swagger.yml')
urls = [x.pattern for x in specification.paths]
print(urls)
# Output
#
# >> ['/users', '/users/{uuid}']
Get operation with supported HTTP methods
from openapi_parser import parse
specification = parse('tests/data/swagger.yml')
for operation in specification.paths:
pattern = operation.pattern
supported_methods = ','.join([x.name for x in operation.item.operations])
print(f"Operation: {pattern}, methods: {supported_methods}")
# Output
#
# >> Operation: /users, methods: GET,POST
# >> Operation: /users/{uuid}, methods: GET,PUT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
openapi3-parser-0.0.8.tar.gz
(12.4 kB
view hashes)
Built Distribution
Close
Hashes for openapi3_parser-0.0.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 506633a1fb2b14bf53b13ee902d03a55549e890062780a3121e4e47ade21139a |
|
MD5 | 9774e05e7d188b0ea9d8b1bc67502c7c |
|
BLAKE2b-256 | eb75aa89ff66048e7f58c0cced01bf564734d73adf44a629ae45e05d868948e5 |