Skip to content

zloyuser/openapi-tools

Repository files navigation

OpenAPI v3 Tools

Build Status PyPI PyPI

OpenAPI v3 object model and helpers.

Installation

pip install openapitools

Usage

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')
builder.contact('John Doe', 'https://example.com', '[email protected]')

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

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

print(builder.build())

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages