def get_openapi(
*,
title: str,
version: str,
openapi_version: str = "3.0.2",
description: Optional[str] = None,
routes: Sequence[BaseRoute],
tags: Optional[List[Dict[str, Any]]] = None,
servers: Optional[List[Dict[str, Union[str, Any]]]] = None,
terms_of_service: Optional[str] = None,
contact: Optional[Dict[str, Union[str, Any]]] = None,
license_info: Optional[Dict[str, Union[str, Any]]] = None,
) -> Dict[str, Any]:
info: Dict[str, Any] = {"title": title, "version": version}
if description:
info["description"] = description
if terms_of_service:
info["termsOfService"] = terms_of_service
if contact:
info["contact"] = contact
if license_info:
info["license"] = license_info
output: Dict[str, Any] = {"openapi": openapi_version, "info": info}
if servers:
output["servers"] = servers
components: Dict[str, Dict[str, Any]] = {}
paths: Dict[str, Dict[str, Any]] = {}
operation_ids: Set[str] = set()
flat_models = get_flat_models_from_routes(routes)
model_name_map = get_model_name_map(flat_models)
definitions = get_model_definitions(flat_models=flat_models,
model_name_map=model_name_map)
for route in routes:
if isinstance(route, routing.APIRoute):
result = get_openapi_path(route=route,
model_name_map=model_name_map,
operation_ids=operation_ids)
if result:
path, security_schemes, path_definitions = result
if path:
paths.setdefault(route.path_format, {}).update(path)
if security_schemes:
components.setdefault("securitySchemes",
{}).update(security_schemes)
if path_definitions:
definitions.update(path_definitions)
if definitions:
components["schemas"] = {
k: definitions[k]
for k in sorted(definitions)
}
if components:
output["components"] = components
output["paths"] = paths
if tags:
output["tags"] = tags
return jsonable_encoder(OpenAPI(**output),
by_alias=True,
exclude_none=True) # type: ignore
def get_openapi(
*,
title: str,
version: str,
openapi_version: str = "3.0.2",
description: Optional[str] = None,
routes: Sequence[BaseRoute],
tags: Optional[List[Dict[str, Any]]] = None,
servers: Optional[List[Dict[str, Union[str, Any]]]] = None,
) -> Dict:
info = {"title": title, "version": version}
if description:
info["description"] = description
output: Dict[str, Any] = {"openapi": openapi_version, "info": info}
if servers:
output["servers"] = servers
components: Dict[str, Dict] = {}
paths: Dict[str, Dict] = {}
flat_models = get_flat_models_from_routes(routes)
# ignore mypy error until enum schemas are released
model_name_map = get_model_name_map(flat_models) # type: ignore
# ignore mypy error until enum schemas are released
definitions = get_model_definitions(
flat_models=flat_models,
model_name_map=model_name_map # type: ignore
)
for route in routes:
if isinstance(route, routing.APIRoute):
result = get_openapi_path(route=route,
model_name_map=model_name_map)
if result:
path, security_schemes, path_definitions = result
if path:
old_path = paths.get(route.path_format, {}) # New
new_path = conservative_merger.merge(old_path, path) # New
paths[route.path_format] = new_path # New
# paths.setdefault(route.path_format, {}).update(path) # Old
if security_schemes:
components.setdefault("securitySchemes",
{}).update(security_schemes)
if path_definitions:
definitions.update(path_definitions)
if definitions:
definitions.update(geojson)
components["schemas"] = {
k: definitions[k]
for k in sorted(definitions)
}
if components:
output["components"] = components
output["paths"] = paths
if tags:
output["tags"] = tags
return jsonable_encoder(OpenAPI(**output),
by_alias=True,
exclude_none=True)
def get_openapi(*,
title: str,
version: str,
openapi_version: str = "3.0.2",
description: str = None,
routes: Sequence[BaseRoute],
openapi_prefix: str = "") -> Dict:
info = {"title": title, "version": version}
if description:
info["description"] = description
output = {"openapi": openapi_version, "info": info}
components: Dict[str, Dict] = {}
paths: Dict[str, Dict] = {}
definitions: Dict[str, Any] = {}
for route in routes:
if isinstance(route, routing.APIRoute):
flat_models = get_flat_models_from_routes([route])
model_name_map = get_model_name_map(flat_models)
definitions.update(
get_model_definitions(
by_alias=route.response_model_by_alias,
flat_models=flat_models,
model_name_map=model_name_map,
))
result = get_openapi_path(route=route,
model_name_map=model_name_map)
if result:
path, security_schemes, path_definitions = result
if path:
paths.setdefault(openapi_prefix + route.path_format,
{}).update(path)
if security_schemes:
components.setdefault("securitySchemes",
{}).update(security_schemes)
if path_definitions:
definitions.update(path_definitions)
if definitions:
components["schemas"] = {
k: definitions[k]
for k in sorted(definitions)
}
if components:
output["components"] = components
output["paths"] = paths
return jsonable_encoder(OpenAPI(**output),
by_alias=True,
exclude_none=True)
