pythonasyncioapiasyncfastapiframeworkjsonjson-schemaopenapiopenapi3pydanticpython-typespython3redocreststarletteswaggerswagger-uiuvicornweb
352 lines
10 KiB
352 lines
10 KiB
import logging
|
|
from enum import Enum
|
|
from typing import Any, Dict, List, Optional, Union
|
|
|
|
from pydantic import BaseModel, Schema as PSchema
|
|
from pydantic.types import UrlStr
|
|
|
|
logger = logging.getLogger("fastapi")
|
|
|
|
try:
|
|
import email_validator
|
|
|
|
assert email_validator # make autoflake ignore the unused import
|
|
from pydantic.types import EmailStr
|
|
except ImportError: # pragma: no cover
|
|
logger.warning(
|
|
"email-validator not installed, email fields will be treated as str.\n"
|
|
+ "To install, run: pip install email-validator"
|
|
)
|
|
|
|
class EmailStr(str): # type: ignore
|
|
pass
|
|
|
|
|
|
class Contact(BaseModel):
|
|
name: Optional[str] = None
|
|
url: Optional[UrlStr] = None
|
|
email: Optional[EmailStr] = None
|
|
|
|
|
|
class License(BaseModel):
|
|
name: str
|
|
url: Optional[UrlStr] = None
|
|
|
|
|
|
class Info(BaseModel):
|
|
title: str
|
|
description: Optional[str] = None
|
|
termsOfService: Optional[str] = None
|
|
contact: Optional[Contact] = None
|
|
license: Optional[License] = None
|
|
version: str
|
|
|
|
|
|
class ServerVariable(BaseModel):
|
|
enum: Optional[List[str]] = None
|
|
default: str
|
|
description: Optional[str] = None
|
|
|
|
|
|
class Server(BaseModel):
|
|
url: UrlStr
|
|
description: Optional[str] = None
|
|
variables: Optional[Dict[str, ServerVariable]] = None
|
|
|
|
|
|
class Reference(BaseModel):
|
|
ref: str = PSchema(..., alias="$ref") # type: ignore
|
|
|
|
|
|
class Discriminator(BaseModel):
|
|
propertyName: str
|
|
mapping: Optional[Dict[str, str]] = None
|
|
|
|
|
|
class XML(BaseModel):
|
|
name: Optional[str] = None
|
|
namespace: Optional[str] = None
|
|
prefix: Optional[str] = None
|
|
attribute: Optional[bool] = None
|
|
wrapped: Optional[bool] = None
|
|
|
|
|
|
class ExternalDocumentation(BaseModel):
|
|
description: Optional[str] = None
|
|
url: UrlStr
|
|
|
|
|
|
class SchemaBase(BaseModel):
|
|
ref: Optional[str] = PSchema(None, alias="$ref") # type: ignore
|
|
title: Optional[str] = None
|
|
multipleOf: Optional[float] = None
|
|
maximum: Optional[float] = None
|
|
exclusiveMaximum: Optional[float] = None
|
|
minimum: Optional[float] = None
|
|
exclusiveMinimum: Optional[float] = None
|
|
maxLength: Optional[int] = PSchema(None, gte=0) # type: ignore
|
|
minLength: Optional[int] = PSchema(None, gte=0) # type: ignore
|
|
pattern: Optional[str] = None
|
|
maxItems: Optional[int] = PSchema(None, gte=0) # type: ignore
|
|
minItems: Optional[int] = PSchema(None, gte=0) # type: ignore
|
|
uniqueItems: Optional[bool] = None
|
|
maxProperties: Optional[int] = PSchema(None, gte=0) # type: ignore
|
|
minProperties: Optional[int] = PSchema(None, gte=0) # type: ignore
|
|
required: Optional[List[str]] = None
|
|
enum: Optional[List[str]] = None
|
|
type: Optional[str] = None
|
|
allOf: Optional[List[Any]] = None
|
|
oneOf: Optional[List[Any]] = None
|
|
anyOf: Optional[List[Any]] = None
|
|
not_: Optional[List[Any]] = PSchema(None, alias="not") # type: ignore
|
|
items: Optional[Any] = None
|
|
properties: Optional[Dict[str, Any]] = None
|
|
additionalProperties: Optional[Union[Dict[str, Any], bool]] = None
|
|
description: Optional[str] = None
|
|
format: Optional[str] = None
|
|
default: Optional[Any] = None
|
|
nullable: Optional[bool] = None
|
|
discriminator: Optional[Discriminator] = None
|
|
readOnly: Optional[bool] = None
|
|
writeOnly: Optional[bool] = None
|
|
xml: Optional[XML] = None
|
|
externalDocs: Optional[ExternalDocumentation] = None
|
|
example: Optional[Any] = None
|
|
deprecated: Optional[bool] = None
|
|
|
|
|
|
class Schema(SchemaBase):
|
|
allOf: Optional[List[SchemaBase]] = None
|
|
oneOf: Optional[List[SchemaBase]] = None
|
|
anyOf: Optional[List[SchemaBase]] = None
|
|
not_: Optional[List[SchemaBase]] = PSchema(None, alias="not") # type: ignore
|
|
items: Optional[SchemaBase] = None
|
|
properties: Optional[Dict[str, SchemaBase]] = None
|
|
additionalProperties: Optional[Union[SchemaBase, bool]] = None # type: ignore
|
|
|
|
|
|
class Example(BaseModel):
|
|
summary: Optional[str] = None
|
|
description: Optional[str] = None
|
|
value: Optional[Any] = None
|
|
externalValue: Optional[UrlStr] = None
|
|
|
|
|
|
class ParameterInType(Enum):
|
|
query = "query"
|
|
header = "header"
|
|
path = "path"
|
|
cookie = "cookie"
|
|
|
|
|
|
class Encoding(BaseModel):
|
|
contentType: Optional[str] = None
|
|
# Workaround OpenAPI recursive reference, using Any
|
|
headers: Optional[Dict[str, Union[Any, Reference]]] = None
|
|
style: Optional[str] = None
|
|
explode: Optional[bool] = None
|
|
allowReserved: Optional[bool] = None
|
|
|
|
|
|
class MediaType(BaseModel):
|
|
schema_: Optional[Union[Schema, Reference]] = PSchema( # type: ignore
|
|
None, alias="schema"
|
|
)
|
|
example: Optional[Any] = None
|
|
examples: Optional[Dict[str, Union[Example, Reference]]] = None
|
|
encoding: Optional[Dict[str, Encoding]] = None
|
|
|
|
|
|
class ParameterBase(BaseModel):
|
|
description: Optional[str] = None
|
|
required: Optional[bool] = None
|
|
deprecated: Optional[bool] = None
|
|
# Serialization rules for simple scenarios
|
|
style: Optional[str] = None
|
|
explode: Optional[bool] = None
|
|
allowReserved: Optional[bool] = None
|
|
schema_: Optional[Union[Schema, Reference]] = PSchema( # type: ignore
|
|
None, alias="schema"
|
|
)
|
|
example: Optional[Any] = None
|
|
examples: Optional[Dict[str, Union[Example, Reference]]] = None
|
|
# Serialization rules for more complex scenarios
|
|
content: Optional[Dict[str, MediaType]] = None
|
|
|
|
|
|
class Parameter(ParameterBase):
|
|
name: str
|
|
in_: ParameterInType = PSchema(..., alias="in") # type: ignore
|
|
|
|
|
|
class Header(ParameterBase):
|
|
pass
|
|
|
|
|
|
# Workaround OpenAPI recursive reference
|
|
class EncodingWithHeaders(Encoding):
|
|
headers: Optional[Dict[str, Union[Header, Reference]]] = None
|
|
|
|
|
|
class RequestBody(BaseModel):
|
|
description: Optional[str] = None
|
|
content: Dict[str, MediaType]
|
|
required: Optional[bool] = None
|
|
|
|
|
|
class Link(BaseModel):
|
|
operationRef: Optional[str] = None
|
|
operationId: Optional[str] = None
|
|
parameters: Optional[Dict[str, Union[Any, str]]] = None
|
|
requestBody: Optional[Union[Any, str]] = None
|
|
description: Optional[str] = None
|
|
server: Optional[Server] = None
|
|
|
|
|
|
class Response(BaseModel):
|
|
description: str
|
|
headers: Optional[Dict[str, Union[Header, Reference]]] = None
|
|
content: Optional[Dict[str, MediaType]] = None
|
|
links: Optional[Dict[str, Union[Link, Reference]]] = None
|
|
|
|
|
|
class Operation(BaseModel):
|
|
tags: Optional[List[str]] = None
|
|
summary: Optional[str] = None
|
|
description: Optional[str] = None
|
|
externalDocs: Optional[ExternalDocumentation] = None
|
|
operationId: Optional[str] = None
|
|
parameters: Optional[List[Union[Parameter, Reference]]] = None
|
|
requestBody: Optional[Union[RequestBody, Reference]] = None
|
|
responses: Dict[str, Response]
|
|
# Workaround OpenAPI recursive reference
|
|
callbacks: Optional[Dict[str, Union[Dict[str, Any], Reference]]] = None
|
|
deprecated: Optional[bool] = None
|
|
security: Optional[List[Dict[str, List[str]]]] = None
|
|
servers: Optional[List[Server]] = None
|
|
|
|
|
|
class PathItem(BaseModel):
|
|
ref: Optional[str] = PSchema(None, alias="$ref") # type: ignore
|
|
summary: Optional[str] = None
|
|
description: Optional[str] = None
|
|
get: Optional[Operation] = None
|
|
put: Optional[Operation] = None
|
|
post: Optional[Operation] = None
|
|
delete: Optional[Operation] = None
|
|
options: Optional[Operation] = None
|
|
head: Optional[Operation] = None
|
|
patch: Optional[Operation] = None
|
|
trace: Optional[Operation] = None
|
|
servers: Optional[List[Server]] = None
|
|
parameters: Optional[List[Union[Parameter, Reference]]] = None
|
|
|
|
|
|
# Workaround OpenAPI recursive reference
|
|
class OperationWithCallbacks(BaseModel):
|
|
callbacks: Optional[Dict[str, Union[Dict[str, PathItem], Reference]]] = None
|
|
|
|
|
|
class SecuritySchemeType(Enum):
|
|
apiKey = "apiKey"
|
|
http = "http"
|
|
oauth2 = "oauth2"
|
|
openIdConnect = "openIdConnect"
|
|
|
|
|
|
class SecurityBase(BaseModel):
|
|
type_: SecuritySchemeType = PSchema(..., alias="type") # type: ignore
|
|
description: Optional[str] = None
|
|
|
|
|
|
class APIKeyIn(Enum):
|
|
query = "query"
|
|
header = "header"
|
|
cookie = "cookie"
|
|
|
|
|
|
class APIKey(SecurityBase):
|
|
type_ = PSchema(SecuritySchemeType.apiKey, alias="type") # type: ignore
|
|
in_: APIKeyIn = PSchema(..., alias="in") # type: ignore
|
|
name: str
|
|
|
|
|
|
class HTTPBase(SecurityBase):
|
|
type_ = PSchema(SecuritySchemeType.http, alias="type") # type: ignore
|
|
scheme: str
|
|
|
|
|
|
class HTTPBearer(HTTPBase):
|
|
scheme = "bearer"
|
|
bearerFormat: Optional[str] = None
|
|
|
|
|
|
class OAuthFlow(BaseModel):
|
|
refreshUrl: Optional[str] = None
|
|
scopes: Dict[str, str] = {}
|
|
|
|
|
|
class OAuthFlowImplicit(OAuthFlow):
|
|
authorizationUrl: str
|
|
|
|
|
|
class OAuthFlowPassword(OAuthFlow):
|
|
tokenUrl: str
|
|
|
|
|
|
class OAuthFlowClientCredentials(OAuthFlow):
|
|
tokenUrl: str
|
|
|
|
|
|
class OAuthFlowAuthorizationCode(OAuthFlow):
|
|
authorizationUrl: str
|
|
tokenUrl: str
|
|
|
|
|
|
class OAuthFlows(BaseModel):
|
|
implicit: Optional[OAuthFlowImplicit] = None
|
|
password: Optional[OAuthFlowPassword] = None
|
|
clientCredentials: Optional[OAuthFlowClientCredentials] = None
|
|
authorizationCode: Optional[OAuthFlowAuthorizationCode] = None
|
|
|
|
|
|
class OAuth2(SecurityBase):
|
|
type_ = PSchema(SecuritySchemeType.oauth2, alias="type") # type: ignore
|
|
flows: OAuthFlows
|
|
|
|
|
|
class OpenIdConnect(SecurityBase):
|
|
type_ = PSchema(SecuritySchemeType.openIdConnect, alias="type") # type: ignore
|
|
openIdConnectUrl: str
|
|
|
|
|
|
SecurityScheme = Union[APIKey, HTTPBase, OAuth2, OpenIdConnect, HTTPBearer]
|
|
|
|
|
|
class Components(BaseModel):
|
|
schemas: Optional[Dict[str, Union[Schema, Reference]]] = None
|
|
responses: Optional[Dict[str, Union[Response, Reference]]] = None
|
|
parameters: Optional[Dict[str, Union[Parameter, Reference]]] = None
|
|
examples: Optional[Dict[str, Union[Example, Reference]]] = None
|
|
requestBodies: Optional[Dict[str, Union[RequestBody, Reference]]] = None
|
|
headers: Optional[Dict[str, Union[Header, Reference]]] = None
|
|
securitySchemes: Optional[Dict[str, Union[SecurityScheme, Reference]]] = None
|
|
links: Optional[Dict[str, Union[Link, Reference]]] = None
|
|
callbacks: Optional[Dict[str, Union[Dict[str, PathItem], Reference]]] = None
|
|
|
|
|
|
class Tag(BaseModel):
|
|
name: str
|
|
description: Optional[str] = None
|
|
externalDocs: Optional[ExternalDocumentation] = None
|
|
|
|
|
|
class OpenAPI(BaseModel):
|
|
openapi: str
|
|
info: Info
|
|
servers: Optional[List[Server]] = None
|
|
paths: Dict[str, PathItem]
|
|
components: Optional[Components] = None
|
|
security: Optional[List[Dict[str, List[str]]]] = None
|
|
tags: Optional[List[Tag]] = None
|
|
externalDocs: Optional[ExternalDocumentation] = None
|
|
|