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

model_config 類別屬性 實例屬性

model_config = {'extra': 'allow'}

name 類別屬性 實例屬性

name = None

url 類別屬性 實例屬性

url = None

email 類別屬性 實例屬性

email = None

Config

extra 類別屬性 實例屬性

extra = 'allow'

授權 (License)

基底類別： BaseModelWithConfig

model_config 類別屬性 實例屬性

model_config = {'extra': 'allow'}

名稱 (name) 實例屬性

name

識別碼 (identifier) 類別屬性 實例屬性

identifier = None

網址 (url) 類別屬性 實例屬性

url = None

設定 (Config)

額外資訊 (extra) 類別屬性 實例屬性

extra = 'allow'

資訊 (Info)

基底類別： BaseModelWithConfig

model_config 類別屬性 實例屬性

model_config = {'extra': 'allow'}

標題 (title) 實例屬性

title

摘要 (summary) 類別屬性 實例屬性

summary = None

描述 (description) 類別屬性 實例屬性

description = None

服務條款 (termsOfService) 類別屬性 實例屬性

termsOfService = None

聯絡資訊 (contact) 類別屬性 實例屬性

contact = None

license 類別屬性 實例屬性

license = None

version 實例屬性

version

Config

extra 類別屬性 實例屬性

extra = 'allow'

ServerVariable

基底類別： BaseModelWithConfig

model_config 類別屬性 實例屬性

model_config = {'extra': 'allow'}

enum 類別屬性 實例屬性

enum = None

default 實例屬性

default

description 類別屬性 實例屬性

description = None

Config

extra 類別屬性 實例屬性

extra = 'allow'

Server

基底類別： BaseModelWithConfig

model_config 類別屬性 實例屬性

model_config = {'extra': 'allow'}

url 實例屬性

url

description 類別屬性 實例屬性

description = None

variables 類別屬性 實例屬性

variables = None

Config

extra 類別屬性 實例屬性

extra = 'allow'

Reference

基底類別： BaseModel

ref 類別屬性 實例屬性

ref = Field(alias='$ref')

Discriminator

基底類別： BaseModel

propertyName 實例屬性

propertyName

mapping 類別屬性 實例屬性

mapping = None

XML

基底類別： BaseModelWithConfig

model_config 類別屬性 實例屬性

model_config = {'extra': 'allow'}

name 類別屬性 實例屬性

name = None

namespace 類別屬性 實例屬性

namespace = None

prefix 類別屬性 實例屬性

prefix = None

attribute 類別屬性 實例屬性

attribute = None

wrapped 類別屬性 實例屬性

wrapped = None

Config

extra 類別屬性 實例屬性

extra = 'allow'

ExternalDocumentation

基底類別： BaseModelWithConfig

model_config 類別屬性 實例屬性

model_config = {'extra': 'allow'}

description 類別屬性 實例屬性

description = None

url 實例屬性

url

Config

extra 類別屬性 實例屬性

extra = 'allow'

Schema

基底類別： BaseModelWithConfig

model_config 類別屬性 實例屬性

model_config = {'extra': 'allow'}

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。

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

model_config 類別屬性 實例屬性

model_config = {'extra': 'allow'}

contentType 類別屬性 實例屬性

contentType = None

headers 類別屬性 實例屬性

headers = None

style 類別屬性 實例屬性

style = None

explode 類別屬性 實例屬性

explode = None

allowReserved 類別屬性 實例屬性

allowReserved = None

Config

extra 類別屬性 實例屬性

extra = 'allow'

MediaType

基底類別： BaseModelWithConfig

model_config 類別屬性 實例屬性

model_config = {'extra': 'allow'}

schema_ 類別屬性 實例屬性

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

example 類別屬性 實例屬性

example = None

examples 類別屬性 實例屬性

examples = None

encoding 類別屬性 實例屬性

encoding = None

Config

extra 類別屬性 實例屬性

extra = 'allow'

ParameterBase

基底類別： BaseModelWithConfig

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'

Parameter

基底類別： 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

name 實例屬性

name

in_ 類別屬性 實例屬性

in_ = Field(alias='in')

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

model_config 類別屬性 實例屬性

model_config = {'extra': 'allow'}

description 類別屬性 實例屬性

description = None

content 實例屬性

content

required 類別屬性 實例屬性

required = None

設定 (Config)

額外 (extra) 類別屬性 (class-attribute) 實例屬性 (instance-attribute)

extra = 'allow'

連結 (Link)

基底類別： BaseModelWithConfig

模型設定 (model_config) 類別屬性 (class-attribute) 實例屬性 (instance-attribute)

model_config = {'extra': 'allow'}

操作參考 (operationRef) 類別屬性 (class-attribute) 實例屬性 (instance-attribute)

operationRef = None

操作ID (operationId) 類別屬性 (class-attribute) 實例屬性 (instance-attribute)

operationId = None

參數 (parameters) 類別屬性 (class-attribute) 實例屬性 (instance-attribute)

parameters = None

請求主體 (requestBody) 類別屬性 (class-attribute) 實例屬性 (instance-attribute)

requestBody = None

描述 (description) 類別屬性 (class-attribute) 實例屬性 (instance-attribute)

description = None

伺服器 (server) 類別屬性 (class-attribute) 實例屬性 (instance-attribute)

server = None

設定 (Config)

額外 (extra) 類別屬性 (class-attribute) 實例屬性 (instance-attribute)

extra = 'allow'

回應 (Response)

基底類別： BaseModelWithConfig

模型設定 (model_config) 類別屬性 (class-attribute) 實例屬性 (instance-attribute)

model_config = {'extra': 'allow'}

description 實例屬性

description

headers 類別屬性 實例屬性

headers = None

content 類別屬性 實例屬性

content = None

links 類別屬性 實例屬性

links = None

Config

extra 類別屬性 實例屬性

extra = 'allow'

Operation

基底類別： BaseModelWithConfig

model_config 類別屬性 實例屬性

model_config = {'extra': 'allow'}

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

Config

extra 類別屬性 實例屬性

extra = 'allow'

PathItem

基底類別： BaseModelWithConfig

model_config 類別屬性 實例屬性

model_config = {'extra': 'allow'}

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

Config

extra 類別屬性 實例屬性

extra = 'allow'

SecuritySchemeType

基底： Enum

apiKey 類別屬性 實例屬性

apiKey = 'apiKey'

http 類別屬性 實例屬性

http = 'http'

oauth2 類別屬性 實例屬性

oauth2 = 'oauth2'

openIdConnect 類別屬性 實例屬性

openIdConnect = 'openIdConnect'

SecurityBase

基底類別： BaseModelWithConfig

model_config 類別屬性 實例屬性

model_config = {'extra': 'allow'}

type_ 類別屬性 實例屬性

type_ = Field(alias='type')

description 類別屬性 實例屬性

description = None

Config

extra 類別屬性 實例屬性

extra = 'allow'

APIKeyIn

基底： Enum

query 類別屬性 實例屬性

query = 'query'

header 類別屬性 實例屬性

header = 'header'

cookie 類別屬性 實例屬性

cookie = 'cookie'

APIKey

繼承自： SecurityBase

model_config 類別屬性 實例屬性

model_config = {'extra': 'allow'}

description 類別屬性 實例屬性

description = None

type_ 類別屬性 實例屬性

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

in_ 類別屬性 實例屬性

in_ = Field(alias='in')

name 實例屬性

name

Config

extra 類別屬性 實例屬性

extra = 'allow'

HTTPBase

繼承自： SecurityBase

model_config 類別屬性 實例屬性

model_config = {'extra': 'allow'}

description 類別屬性 實例屬性

description = None

type_ 類別屬性 實例屬性

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

scheme 實例屬性

scheme

Config

extra 類別屬性 實例屬性

extra = 'allow'

HTTPBearer

基底類別： HTTPBase

model_config 類別屬性 實例屬性

model_config = {'extra': 'allow'}

type_ 類別屬性 實例屬性

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

description 類別屬性 實例屬性

description = None

scheme 類別屬性 實例屬性

scheme = 'bearer'

bearerFormat 類別屬性 實例屬性

bearerFormat = None

Config

extra 類別屬性 實例屬性

extra = 'allow'

OAuthFlow

基底類別： BaseModelWithConfig

model_config 類別屬性 實例屬性

model_config = {'extra': 'allow'}

refreshUrl 類別屬性 實例屬性

refreshUrl = None

scopes 類別屬性 實例屬性

scopes = {}

Config

extra 類別屬性 實例屬性

extra = 'allow'

OAuthFlowImplicit

基底類別： OAuthFlow

model_config 類別屬性 實例屬性

model_config = {'extra': 'allow'}

refreshUrl 類別屬性 實例屬性

refreshUrl = None

scopes 類別屬性 實例屬性

scopes = {}

authorizationUrl 實例屬性

authorizationUrl

Config

extra 類別屬性 實例屬性

extra = 'allow'

OAuthFlowPassword

基底類別： OAuthFlow

model_config 類別屬性 實例屬性

model_config = {'extra': 'allow'}

refreshUrl 類別屬性 實例屬性

refreshUrl = None

scopes 類別屬性 實例屬性

scopes = {}

tokenUrl 實例屬性

tokenUrl

Config

extra 類別屬性 實例屬性

extra = 'allow'

OAuthFlowClientCredentials

基底類別： OAuthFlow

model_config 類別屬性 實例屬性

model_config = {'extra': 'allow'}

refreshUrl 類別屬性 實例屬性

refreshUrl = None

scopes 類別屬性 實例屬性

scopes = {}

tokenUrl 實例屬性

tokenUrl

Config

extra 類別屬性 實例屬性

extra = 'allow'

OAuthFlowAuthorizationCode

基底類別： OAuthFlow

model_config 類別屬性 實例屬性

model_config = {'extra': 'allow'}

refreshUrl 類別屬性 實例屬性

refreshUrl = None

scopes 類別屬性 實例屬性

scopes = {}

authorizationUrl 實例屬性

authorizationUrl

tokenUrl 實例屬性

tokenUrl

Config

extra 類別屬性 實例屬性

extra = 'allow'

OAuthFlows

基底類別： BaseModelWithConfig

model_config 類別屬性 實例屬性

model_config = {'extra': 'allow'}

implicit 類別屬性 實例屬性

implicit = None

password 類別屬性 實例屬性

password = None

clientCredentials 類別屬性 實例屬性

clientCredentials = None

authorizationCode 類別屬性 實例屬性

authorizationCode = None

Config

extra 類別屬性 實例屬性

extra = 'allow'

OAuth2

繼承自： SecurityBase

model_config 類別屬性 實例屬性

model_config = {'extra': 'allow'}

description 類別屬性 實例屬性

description = None

type_ 類別屬性 實例屬性

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

flows 實例屬性

flows

Config

extra 類別屬性 實例屬性

extra = 'allow'

OpenIdConnect

繼承自： SecurityBase

model_config 類別屬性 實例屬性

model_config = {'extra': 'allow'}

description 類別屬性 實例屬性

description = None

type_ 類別屬性 實例屬性

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

openIdConnectUrl 實例屬性

openIdConnectUrl

Config

extra 類別屬性 實例屬性

extra = 'allow'

Components

基底類別： BaseModelWithConfig

model_config 類別屬性 實例屬性

model_config = {'extra': 'allow'}

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

Config

extra 類別屬性 實例屬性

extra = 'allow'

Tag

基底類別： BaseModelWithConfig

model_config 類別屬性 實例屬性

model_config = {'extra': 'allow'}

name 實例屬性

name

description 類別屬性 實例屬性

description = None

externalDocs 類別屬性 實例屬性

externalDocs = None

Config

extra 類別屬性 實例屬性

extra = 'allow'

OpenAPI

基底類別： BaseModelWithConfig

model_config 類別屬性 實例屬性

model_config = {'extra': 'allow'}

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

Config

extra 類別屬性 實例屬性

extra = 'allow'