python-openapi 0.1.6

Generate an OpenAPI specification from a Python class definition

Generate an OpenAPI specification from a Python class

PyOpenAPI produces an OpenAPI specification in JSON, YAML or HTML format with endpoint definitions extracted from member functions of a strongly-typed Python class.

Features

• supports standard and asynchronous functions (async def)
• maps function name prefixes such as get_ or create_ to HTTP GET, POST, PUT, DELETE, PATCH
• handles both simple and composite types (int, str, Enum, @dataclass)
• handles generic types (List[T], Dict[K, V], Optional[T], Union[T1, T2, T3])
• maps Python positional-only and keyword-only arguments (of simple types) to path and query parameters, respectively
• maps composite types to HTTP request body
• supports user-defined routes, request and response samples with decorator @webmethod
• extracts description text from class and function doc-strings (__doc__)
• recognizes parameter description text given in reStructuredText doc-string format (:param name: ...)
• converts exceptions declared in doc-strings into HTTP 4xx and 5xx responses (e.g. :raises TypeError:)
• recursively converts composite types into JSON schemas
• groups frequently used composite types into a separate section and re-uses them with $ref
• displays generated OpenAPI specification in HTML with ReDoc

Examples

• Endpoint definition in Python
• Generated OpenAPI specification in JSON
• Generated OpenAPI specification in YAML
• Generated OpenAPI specification in HTML with ReDoc