OpenAPI models

OpenAPI Pydantic models used to generate and validate the generated OpenAPI.

fastapi.openapi.models

SchemaType module attribute

SchemaType = Literal[
    "array",
    "boolean",
    "integer",
    "null",
    "number",
    "object",
    "string",
]

SchemaOrBool module attribute

SchemaOrBool = Union[Schema, bool]

SecurityScheme module attribute

SecurityScheme = Union[
    APIKey, HTTPBase, OAuth2, OpenIdConnect, HTTPBearer
]

BaseModelWithConfig

Bases: BaseModel

model_config class attribute instance attribute

model_config = {'extra': 'allow'}

Contact

Bases: BaseModelWithConfig

name class attribute instance attribute

name = None

url class attribute instance attribute

url = None

email class attribute instance attribute

email = None

model_config class attribute instance attribute

model_config = {'extra': 'allow'}

License

Bases: BaseModelWithConfig

name instance attribute

name

identifier class attribute instance attribute

identifier = None

url class attribute instance attribute

url = None

model_config class attribute instance attribute

model_config = {'extra': 'allow'}

Info

Bases: BaseModelWithConfig

title instance attribute

title

summary class attribute instance attribute

summary = None

description class attribute instance attribute

description = None

termsOfService class attribute instance attribute

termsOfService = None

contact class attribute instance attribute

contact = None

license class attribute instance attribute

license = None

version instance attribute

version

model_config class attribute instance attribute

model_config = {'extra': 'allow'}

ServerVariable

Bases: BaseModelWithConfig

enum class attribute instance attribute

enum = None

default instance attribute

default

description class attribute instance attribute

description = None

model_config class attribute instance attribute

model_config = {'extra': 'allow'}

Server

Bases: BaseModelWithConfig

url instance attribute

url

description class attribute instance attribute

description = None

variables class attribute instance attribute

variables = None

model_config class attribute instance attribute

model_config = {'extra': 'allow'}

Reference

Bases: BaseModel

ref class attribute instance attribute

ref = Field(alias='$ref')

Discriminator

Bases: BaseModel

propertyName instance attribute

propertyName

mapping class attribute instance attribute

mapping = None

XML

Bases: BaseModelWithConfig

name class attribute instance attribute

name = None

namespace class attribute instance attribute

namespace = None

prefix class attribute instance attribute

prefix = None

attribute class attribute instance attribute

attribute = None

wrapped class attribute instance attribute

wrapped = None

model_config class attribute instance attribute

model_config = {'extra': 'allow'}

ExternalDocumentation

Bases: BaseModelWithConfig

description class attribute instance attribute

description = None

url instance attribute

url

model_config class attribute instance attribute

model_config = {'extra': 'allow'}

Schema

Bases: BaseModelWithConfig

schema_ class attribute instance attribute

schema_ = Field(default=None, alias='$schema')

vocabulary class attribute instance attribute

vocabulary = Field(default=None, alias='$vocabulary')

id class attribute instance attribute

id = Field(default=None, alias='$id')

anchor class attribute instance attribute

anchor = Field(default=None, alias='$anchor')

dynamicAnchor class attribute instance attribute

dynamicAnchor = Field(default=None, alias='$dynamicAnchor')

ref class attribute instance attribute

ref = Field(default=None, alias='$ref')

dynamicRef class attribute instance attribute

dynamicRef = Field(default=None, alias='$dynamicRef')

defs class attribute instance attribute

defs = Field(default=None, alias='$defs')

comment 类属性 实例属性

comment = Field(default=None, alias='$comment')

allOf 类属性 实例属性

allOf = None

anyOf 类属性 实例属性

anyOf = None

oneOf 类属性 实例属性

oneOf = None

not_ 类属性 实例属性

not_ = Field(default=None, alias='not')

if_ 类属性 实例属性

if_ = Field(default=None, alias='if')

then 类属性 实例属性

then = None

else_ 类属性 实例属性

else_ = Field(default=None, alias='else')

dependentSchemas 类属性 实例属性

dependentSchemas = None

prefixItems 类属性 实例属性

prefixItems = None

items 类属性 实例属性

items = None

contains 类属性 实例属性

contains = None

properties 类属性 实例属性

properties = None

patternProperties 类属性 实例属性

patternProperties = None

additionalProperties 类属性 实例属性

additionalProperties = None

propertyNames 类属性 实例属性

propertyNames = None

unevaluatedItems 类属性 实例属性

unevaluatedItems = None

unevaluatedProperties 类属性 实例属性

unevaluatedProperties = None

type 类属性 实例属性

type = None

enum 类属性 实例属性

enum = None

const 类属性 实例属性

const = None

multipleOf 类属性 实例属性

multipleOf = Field(default=None, gt=0)

maximum 类属性 实例属性

maximum = None

exclusiveMaximum 类属性 实例属性

exclusiveMaximum = None

minimum 类属性 实例属性

minimum = None

exclusiveMinimum 类属性 实例属性

exclusiveMinimum = None

maxLength 类属性 实例属性

maxLength = Field(default=None, ge=0)

minLength 类属性 实例属性

minLength = Field(default=None, ge=0)

pattern 类属性 实例属性

pattern = None

maxItems 类属性 实例属性

maxItems = Field(default=None, ge=0)

minItems 类属性 实例属性

minItems = Field(default=None, ge=0)

uniqueItems 类属性 实例属性

uniqueItems = None

maxContains 类属性 实例属性

maxContains = Field(default=None, ge=0)

minContains 类属性 实例属性

minContains = Field(default=None, ge=0)

maxProperties 类属性 实例属性

maxProperties = Field(default=None, ge=0)

minProperties 类属性 实例属性

minProperties = Field(default=None, ge=0)

required 类属性 实例属性

required = None

dependentRequired 类属性 实例属性

dependentRequired = None

format 类属性 实例属性

format = None

contentEncoding 类属性 实例属性

contentEncoding = None

contentMediaType 类属性 实例属性

contentMediaType = None

contentSchema 类属性 实例属性

contentSchema = None

title 类属性 实例属性

title = None

description 类属性 实例属性

description = None

default 类属性 实例属性

default = None

deprecated 类属性 实例属性

deprecated = None

readOnly 类属性 实例属性

readOnly = None

writeOnly 类属性 实例属性

writeOnly = None

examples 类属性 实例属性

examples = None

discriminator 类属性 实例属性

discriminator = None

xml 类属性 实例属性

xml = None

externalDocs 类属性 实例属性

externalDocs = None

example 类属性 实例属性

example = None

在 OpenAPI 3.1.0 中已弃用，现在使用 JSON Schema 2020-12，但仍受支持。请改用 examples。

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

Example

Bases: TypedDict

summary 实例属性

summary

description 实例属性

description

value 实例属性

value

externalValue 实例属性

externalValue

ParameterInType

Bases: Enum

query 类属性 实例属性

query = 'query'

header 类属性 实例属性

header = 'header'

path 类属性 实例属性

path = 'path'

cookie 类属性 实例属性

cookie = 'cookie'

Encoding

Bases: BaseModelWithConfig

contentType 类属性 实例属性

contentType = None

headers 类属性 实例属性

headers = None

style 类属性 实例属性

style = None

explode 类属性 实例属性

explode = None

allowReserved 类属性 实例属性

allowReserved = None

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

MediaType

Bases: BaseModelWithConfig

schema_ 类属性 实例属性

schema_ = Field(default=None, alias='schema')

example 类属性 实例属性

example = None

examples 类属性 实例属性

examples = None

encoding 类属性 实例属性

encoding = None

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

ParameterBase

Bases: BaseModelWithConfig

description 类属性 实例属性

description = None

required 类属性 实例属性

required = None

deprecated 类属性 实例属性

deprecated = None

style 类属性 实例属性

style = None

explode 类属性 实例属性

explode = None

allowReserved 类属性 实例属性

allowReserved = None

schema_ 类属性 实例属性

schema_ = Field(default=None, alias='schema')

example 类属性 实例属性

example = None

examples 类属性 实例属性

examples = None

content 类属性 实例属性

content = None

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

Parameter

Bases: ParameterBase

name 实例属性

name

in_ 类属性 实例属性

in_ = Field(alias='in')

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

description 类属性 实例属性

description = None

required 类属性 实例属性

required = None

deprecated 类属性 实例属性

deprecated = None

style 类属性 实例属性

style = None

explode 类属性 实例属性

explode = None

allowReserved 类属性 实例属性

allowReserved = None

schema_ 类属性 实例属性

schema_ = Field(default=None, alias='schema')

example 类属性 实例属性

example = None

examples 类属性 实例属性

examples = None

content 类属性 实例属性

content = None

Header

Bases: ParameterBase

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

description 类属性 实例属性

description = None

required 类属性 实例属性

required = None

deprecated 类属性 实例属性

deprecated = None

style 类属性 实例属性

style = None

explode 类属性 实例属性

explode = None

allowReserved 类属性 实例属性

allowReserved = None

schema_ 类属性 实例属性

schema_ = Field(default=None, alias='schema')

example 类属性 实例属性

example = None

examples 类属性 实例属性

examples = None

content 类属性 实例属性

content = None

RequestBody

Bases: BaseModelWithConfig

description 类属性 实例属性

description = None

content 实例属性

content

required 类属性 实例属性

required = None

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

Link

Bases: BaseModelWithConfig

operationRef 类属性 实例属性

operationRef = None

operationId 类属性 实例属性

operationId = None

parameters 类属性 实例属性

parameters = None

requestBody 类属性 实例属性

requestBody = None

description 类属性 实例属性

description = None

server 类属性 实例属性

server = None

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

Response

Bases: BaseModelWithConfig

description 实例属性

description

headers 类属性 实例属性

headers = None

content 类属性 实例属性

content = None

links 类属性 实例属性

links = None

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

Operation

Bases: BaseModelWithConfig

tags 类属性 实例属性

tags = None

summary 类属性 实例属性

summary = None

description 类属性 实例属性

description = None

externalDocs 类属性 实例属性

externalDocs = None

operationId 类属性 实例属性

operationId = None

parameters 类属性 实例属性

parameters = None

requestBody 类属性 实例属性

requestBody = None

responses 类属性 实例属性

responses = None

callbacks 类属性 实例属性

callbacks = None

deprecated 类属性 实例属性

deprecated = None

security 类属性 实例属性

security = None

servers 类属性 实例属性

servers = None

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

PathItem

Bases: BaseModelWithConfig

ref 类属性 实例属性

ref = Field(default=None, alias='$ref')

summary 类属性 实例属性

summary = None

description 类属性 实例属性

description = None

get 类属性 实例属性

get = None

put 类属性 实例属性

put = None

post 类属性 实例属性

post = None

delete 类属性 实例属性

delete = None

options 类属性 实例属性

options = None

head 类属性 实例属性

head = None

patch 类属性 实例属性

patch = None

trace 类属性 实例属性

trace = None

servers 类属性 实例属性

servers = None

parameters 类属性 实例属性

parameters = None

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

SecuritySchemeType

Bases: Enum

apiKey 类属性 实例属性

apiKey = 'apiKey'

http 类属性 实例属性

http = 'http'

oauth2 类属性 实例属性

oauth2 = 'oauth2'

openIdConnect 类属性 实例属性

openIdConnect = 'openIdConnect'

SecurityBase

Bases: BaseModelWithConfig

type_ 类属性 实例属性

type_ = Field(alias='type')

description 类属性 实例属性

description = None

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

APIKeyIn

Bases: Enum

query 类属性 实例属性

query = 'query'

header 类属性 实例属性

header = 'header'

cookie 类属性 实例属性

cookie = 'cookie'

APIKey

基类: SecurityBase

type_ 类属性 实例属性

type_ = Field(default=apiKey, alias='type')

in_ 类属性 实例属性

in_ = Field(alias='in')

name 实例属性

name

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

description 类属性 实例属性

description = None

HTTPBase

基类: SecurityBase

type_ 类属性 实例属性

type_ = Field(default=http, alias='type')

scheme 实例属性

scheme

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

description 类属性 实例属性

description = None

HTTPBearer

基类: HTTPBase

scheme 类属性 实例属性

scheme = 'bearer'

bearerFormat 类属性 实例属性

bearerFormat = None

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

type_ 类属性 实例属性

type_ = Field(default=http, alias='type')

description 类属性 实例属性

description = None

OAuthFlow

Bases: BaseModelWithConfig

refreshUrl 类属性 实例属性

refreshUrl = None

scopes 类属性 实例属性

scopes = {}

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

OAuthFlowImplicit

基类: OAuthFlow

authorizationUrl 实例属性

authorizationUrl

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

refreshUrl 类属性 实例属性

refreshUrl = None

scopes 类属性 实例属性

scopes = {}

OAuthFlowPassword

基类: OAuthFlow

tokenUrl 实例属性

tokenUrl

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

refreshUrl 类属性 实例属性

refreshUrl = None

scopes 类属性 实例属性

scopes = {}

OAuthFlowClientCredentials

基类: OAuthFlow

tokenUrl 实例属性

tokenUrl

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

refreshUrl 类属性 实例属性

refreshUrl = None

scopes 类属性 实例属性

scopes = {}

OAuthFlowAuthorizationCode

基类: OAuthFlow

authorizationUrl 实例属性

authorizationUrl

tokenUrl 实例属性

tokenUrl

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

refreshUrl 类属性 实例属性

refreshUrl = None

scopes 类属性 实例属性

scopes = {}

OAuthFlows

Bases: BaseModelWithConfig

implicit 类属性 实例属性

implicit = None

password 类属性 实例属性

password = None

clientCredentials 类属性 实例属性

clientCredentials = None

authorizationCode 类属性 实例属性

authorizationCode = None

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

OAuth2

基类: SecurityBase

type_ 类属性 实例属性

type_ = Field(default=oauth2, alias='type')

flows 实例属性

flows

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

description 类属性 实例属性

description = None

OpenIdConnect

基类: SecurityBase

type_ 类属性 实例属性

type_ = Field(default=openIdConnect, alias='type')

openIdConnectUrl 实例属性

openIdConnectUrl

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

description 类属性 实例属性

description = None

Components

Bases: BaseModelWithConfig

schemas 类属性 实例属性

schemas = None

responses 类属性 实例属性

responses = None

parameters 类属性 实例属性

parameters = None

examples 类属性 实例属性

examples = None

requestBodies 类属性 实例属性

requestBodies = None

headers 类属性 实例属性

headers = None

securitySchemes 类属性 实例属性

securitySchemes = None

links 类属性 实例属性

links = None

callbacks 类属性 实例属性

callbacks = None

pathItems 类属性 实例属性

pathItems = None

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

Tag

Bases: BaseModelWithConfig

name 实例属性

name

description 类属性 实例属性

description = None

externalDocs 类属性 实例属性

externalDocs = None

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

OpenAPI

Bases: BaseModelWithConfig

openapi 实例属性

openapi

info 实例属性

info

jsonSchemaDialect 类属性 实例属性

jsonSchemaDialect = None

servers 类属性 实例属性

servers = None

paths 类属性 实例属性

paths = None

webhooks 类属性 实例属性

webhooks = None

components 类属性 实例属性

components = None

security 类属性 实例属性

security = None

tags 类属性 实例属性

tags = None

externalDocs 类属性 实例属性

externalDocs = None

model_config 类属性 实例属性

model_config = {'extra': 'allow'}