67 lines
1.9 KiB
Python
67 lines
1.9 KiB
Python
import logging
|
|
from typing import Callable
|
|
|
|
from openapi_pydantic import Info, OpenAPI, Operation, PathItem, Response
|
|
from openapi_pydantic.compat import PYDANTIC_V2
|
|
|
|
|
|
def test_readme_example() -> None:
|
|
open_api_1 = readme_example_1()
|
|
assert open_api_1
|
|
dump_json = getattr(open_api_1, "model_dump_json" if PYDANTIC_V2 else "json")
|
|
open_api_json_1 = dump_json(by_alias=True, exclude_none=True, indent=2)
|
|
logging.debug(open_api_json_1)
|
|
assert open_api_json_1
|
|
|
|
open_api_2 = readme_example_2()
|
|
assert open_api_1 == open_api_2
|
|
|
|
open_api_3 = readme_example_3()
|
|
assert open_api_1 == open_api_3
|
|
|
|
|
|
def readme_example_1() -> OpenAPI:
|
|
"""Construct OpenAPI using data class"""
|
|
return OpenAPI(
|
|
info=Info(
|
|
title="My own API",
|
|
version="v0.0.1",
|
|
),
|
|
paths={
|
|
"/ping": PathItem(
|
|
get=Operation(responses={"200": Response(description="pong")})
|
|
)
|
|
},
|
|
)
|
|
|
|
|
|
def readme_example_2() -> OpenAPI:
|
|
"""Construct OpenAPI from raw data object"""
|
|
openapi_validate: Callable[[dict], OpenAPI] = getattr(
|
|
OpenAPI, "model_validate" if PYDANTIC_V2 else "parse_obj"
|
|
)
|
|
return openapi_validate(
|
|
{
|
|
"info": {"title": "My own API", "version": "v0.0.1"},
|
|
"paths": {
|
|
"/ping": {"get": {"responses": {"200": {"description": "pong"}}}}
|
|
},
|
|
}
|
|
)
|
|
|
|
|
|
def readme_example_3() -> OpenAPI:
|
|
"""Construct OpenAPI from mixed object"""
|
|
openapi_validate: Callable[[dict], OpenAPI] = getattr(
|
|
OpenAPI, "model_validate" if PYDANTIC_V2 else "parse_obj"
|
|
)
|
|
return openapi_validate(
|
|
{
|
|
"info": {"title": "My own API", "version": "v0.0.1"},
|
|
"paths": {
|
|
"/ping": PathItem(
|
|
get={"responses": {"200": Response(description="pong")}}
|
|
)
|
|
},
|
|
}
|
|
)
|