Skip to main content

OpenAPI v3 Object Model and Helpers

Project description

OpenAPI v3 Tools

Build Status PyPI PyPI

OpenAPI v3 object model and helpers.


pip install openapitools


from openapitools import SpecificationBuilder, ComponentsBuilder, OperationBuilder, Schema

class Todo:
    id: int
    text: str
    done: False

components = ComponentsBuilder()
components.scheme(Todo.__name__, Schema.make(Todo))

builder = SpecificationBuilder(components)
builder.describe('TODO REST API', '1.0')
builder.license('MIT')'John Doe', '', '')

get_todo = OperationBuilder()
get_todo.parameter('id', int, 'path')
get_todo.describe('Get todo by ID')
get_todo.response(200, Todo)

builder.operation('/todo/{id}', 'GET', get_todo)


Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openapitools-0.0.2.tar.gz (6.2 kB view hashes)

Uploaded source

Built Distribution

openapitools-0.0.2-py3-none-any.whl (8.1 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page