OpenAPI models

用于生成和验证所生成的 OpenAPI 的 OpenAPI Pydantic 模型。

fastapi.openapi.models

SchemaOrBool 模块属性

SchemaOrBool = Union[Schema, bool]

SecurityScheme 模块属性

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

BaseModelWithConfig

基类: BaseModel

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

Config

extra 类属性 实例属性

extra = 'allow'

Contact

基类: BaseModelWithConfig

name 类属性 实例属性

name = None

url 类属性 实例属性

url = None

email 类属性 实例属性

email = None

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

Config

extra 类属性 实例属性

extra = 'allow'

License

基类: BaseModelWithConfig

name 实例属性

name

identifier 类属性 实例属性

identifier = None

url 类属性 实例属性

url = None

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

Config

extra 类属性 实例属性

extra = 'allow'

Info

基类: BaseModelWithConfig

title 实例属性

title

summary 类属性 实例属性

summary = None

description 类属性 实例属性

description = None

termsOfService 类属性 实例属性

termsOfService = None

contact 类属性 实例属性

contact = None

license 类属性 实例属性

license = None

version 实例属性

version

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

Config

extra 类属性 实例属性

extra = 'allow'

ServerVariable

基类: BaseModelWithConfig

enum 类属性 实例属性

enum = None

default 实例属性

default

description 类属性 实例属性

description = None

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

Config

extra 类属性 实例属性

extra = 'allow'

Server

基类: BaseModelWithConfig

url 实例属性

url

description 类属性 实例属性

description = None

variables 类属性 实例属性

variables = None

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

Config

extra 类属性 实例属性

extra = 'allow'

Reference

基类: BaseModel

ref 类属性 实例属性

ref = Field(alias='$ref')

Discriminator

基类: BaseModel

propertyName 实例属性

propertyName

mapping 类属性 实例属性

mapping = None

XML

基类: BaseModelWithConfig

name 类属性 实例属性

name = None

namespace 类属性 实例属性

namespace = None

prefix 类属性 实例属性

prefix = None

attribute 类属性 实例属性

attribute = None

wrapped 类属性 实例属性

wrapped = None

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

Config

extra 类属性 实例属性

extra = 'allow'

ExternalDocumentation

基类: BaseModelWithConfig

description 类属性 实例属性

description = None

url 实例属性

url

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

Config

extra 类属性 实例属性

extra = 'allow'

Schema

基类: BaseModelWithConfig

schema_ 类属性 实例属性

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

vocabulary 类属性 实例属性

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

id 类属性 实例属性

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

anchor 类属性 实例属性

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

dynamicAnchor 类属性 实例属性

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

ref 类属性 实例属性

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

dynamicRef 类属性 实例属性

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

defs 类属性 实例属性

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'}

Config

extra 类属性 实例属性

extra = 'allow'

Example

基类: TypedDict

summary 实例属性

summary

description 实例属性

description

value 实例属性

value

externalValue 实例属性

externalValue

Config

extra 类属性 实例属性

extra = 'allow'

ParameterInType

基类: Enum

query 类属性 实例属性

query = 'query'

header 类属性 实例属性

header = 'header'

path 类属性 实例属性

path = 'path'

cookie 类属性 实例属性

cookie = 'cookie'

Encoding

基类: BaseModelWithConfig

contentType 类属性 实例属性

contentType = None

headers 类属性 实例属性

headers = None

style 类属性 实例属性

style = None

explode 类属性 实例属性

explode = None

allowReserved 类属性 实例属性

allowReserved = None

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

Config

extra 类属性 实例属性

extra = 'allow'

MediaType

基类: BaseModelWithConfig

schema_ 类属性 实例属性

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

example 类属性 实例属性

example = None

examples 类属性 实例属性

examples = None

encoding 类属性 实例属性

encoding = None

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

Config

extra 类属性 实例属性

extra = 'allow'

ParameterBase

基类: 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'}

Config

extra 类属性 实例属性

extra = 'allow'

Parameter

继承自： 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

Config

extra 类属性 实例属性

extra = 'allow'

Header

继承自： 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

Config

extra 类属性 实例属性

extra = 'allow'

RequestBody

基类: BaseModelWithConfig

description 类属性 实例属性

description = None

content 实例属性

content

required 类属性 实例属性

required = None

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

Config

extra 类属性 实例属性

extra = 'allow'

Link

基类: 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'}

Config

extra 类属性 实例属性

extra = 'allow'

Response

基类: BaseModelWithConfig

description 实例属性

description

headers 类属性 实例属性

headers = None

content 类属性 实例属性

content = None

links 类属性 实例属性

links = None

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

Config

extra 类属性 实例属性

extra = 'allow'

Operation

基类: 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'}

Config

extra 类属性 实例属性

extra = 'allow'

PathItem

基类: 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'}

Config

extra 类属性 实例属性

extra = 'allow'

SecuritySchemeType

基类: Enum

apiKey 类属性 实例属性

apiKey = 'apiKey'

http 类属性 实例属性

http = 'http'

oauth2 类属性 实例属性

oauth2 = 'oauth2'

openIdConnect 类属性 实例属性

openIdConnect = 'openIdConnect'

SecurityBase

基类: BaseModelWithConfig

type_ 类属性 实例属性

type_ = Field(alias='type')

description 类属性 实例属性

description = None

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

Config

extra 类属性 实例属性

extra = 'allow'

APIKeyIn

基类: 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

Config

extra 类属性 实例属性

extra = 'allow'

HTTPBase

继承自： SecurityBase

type_ 类属性 实例属性

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

scheme 实例属性

scheme

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

description 类属性 实例属性

description = None

Config

extra 类属性 实例属性

extra = 'allow'

HTTPBearer

继承自： HTTPBase

scheme 类属性 实例属性

scheme = 'bearer'

bearerFormat 类属性 实例属性

bearerFormat = None

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

type_ 类属性 实例属性

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

description 类属性 实例属性

description = None

Config

extra 类属性 实例属性

extra = 'allow'

OAuthFlow

基类: BaseModelWithConfig

refreshUrl 类属性 实例属性

refreshUrl = None

scopes 类属性 实例属性

scopes = {}

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

Config

extra 类属性 实例属性

extra = 'allow'

OAuthFlowImplicit

继承自： OAuthFlow

authorizationUrl 实例属性

authorizationUrl

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

refreshUrl 类属性 实例属性

refreshUrl = None

scopes 类属性 实例属性

scopes = {}

Config

extra 类属性 实例属性

extra = 'allow'

OAuthFlowPassword

继承自： OAuthFlow

tokenUrl 实例属性

tokenUrl

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

refreshUrl 类属性 实例属性

refreshUrl = None

scopes 类属性 实例属性

scopes = {}

Config

extra 类属性 实例属性

extra = 'allow'

OAuthFlowClientCredentials

继承自： OAuthFlow

tokenUrl 实例属性

tokenUrl

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

refreshUrl 类属性 实例属性

refreshUrl = None

scopes 类属性 实例属性

scopes = {}

Config

extra 类属性 实例属性

extra = 'allow'

OAuthFlowAuthorizationCode

继承自： OAuthFlow

authorizationUrl 实例属性

authorizationUrl

tokenUrl 实例属性

tokenUrl

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

refreshUrl 类属性 实例属性

refreshUrl = None

scopes 类属性 实例属性

scopes = {}

Config

extra 类属性 实例属性

extra = 'allow'

OAuthFlows

基类: BaseModelWithConfig

implicit 类属性 实例属性

implicit = None

password 类属性 实例属性

password = None

clientCredentials 类属性 实例属性

clientCredentials = None

authorizationCode 类属性 实例属性

authorizationCode = None

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

Config

extra 类属性 实例属性

extra = 'allow'

OAuth2

继承自： SecurityBase

type_ 类属性 实例属性

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

flows 实例属性

flows

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

description 类属性 实例属性

description = None

Config

extra 类属性 实例属性

extra = 'allow'

OpenIdConnect

继承自： SecurityBase

type_ 类属性 实例属性

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

openIdConnectUrl 实例属性

openIdConnectUrl

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

description 类属性 实例属性

description = None

Config

extra 类属性 实例属性

extra = 'allow'

Components

基类: 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'}

Config

extra 类属性 实例属性

extra = 'allow'

Tag

基类: BaseModelWithConfig

name 实例属性

name

description 类属性 实例属性

description = None

externalDocs 类属性 实例属性

externalDocs = None

model_config 类属性 实例属性

model_config = {'extra': 'allow'}

Config

extra 类属性 实例属性

extra = 'allow'

OpenAPI

基类: 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'}

Config

extra 类属性 实例属性

extra = 'allow'