OpenAPI models

生成されたOpenAPIを生成および検証するために使用されるOpenAPI Pydanticモデル。

fastapi.openapi.models

SchemaOrBool module-attribute

SchemaOrBool = Union[Schema, bool]

SecurityScheme module-attribute

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

BaseModelWithConfig

ベース: BaseModel

model_config class-attribute instance-attribute

model_config = {'extra': 'allow'}

Config

extra class-attribute instance-attribute

extra = 'allow'

Contact

ベース: BaseModelWithConfig

model_config class-attribute instance-attribute

model_config = {'extra': 'allow'}

name class-attribute instance-attribute

name = None

url class-attribute instance-attribute

url = None

email class-attribute instance-attribute

email = None

Config

extra class-attribute instance-attribute

extra = 'allow'

License

ベース: BaseModelWithConfig

model_config class-attribute instance-attribute

model_config = {'extra': 'allow'}

name instance-attribute

name

identifier class-attribute instance-attribute

identifier = None

url class-attribute instance-attribute

url = None

Config

extra class-attribute instance-attribute

extra = 'allow'

Info

ベース: BaseModelWithConfig

model_config class-attribute instance-attribute

model_config = {'extra': 'allow'}

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

Config

extra class-attribute instance-attribute

extra = 'allow'

ServerVariable

ベース: BaseModelWithConfig

model_config class-attribute instance-attribute

model_config = {'extra': 'allow'}

enum class-attribute instance-attribute

enum = None

default instance-attribute

default

description class-attribute instance-attribute

description = None

Config

extra class-attribute instance-attribute

extra = 'allow'

Server

ベース: BaseModelWithConfig

model_config class-attribute instance-attribute

model_config = {'extra': 'allow'}

url instance-attribute

url

description class-attribute instance-attribute

description = None

variables class-attribute instance-attribute

variables = None

Config

extra class-attribute instance-attribute

extra = 'allow'

Reference

ベース: BaseModel

ref class-attribute instance-attribute

ref = Field(alias='$ref')

Discriminator

ベース: BaseModel

propertyName instance-attribute

propertyName

mapping class-attribute instance-attribute

mapping = None

XML

ベース: BaseModelWithConfig

model_config class-attribute instance-attribute

model_config = {'extra': 'allow'}

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

Config

extra class-attribute instance-attribute

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 クラス属性 インスタンス属性

extra = 'allow'

Link

ベース: BaseModelWithConfig

model_config class-attribute instance-attribute

model_config = {'extra': 'allow'}

operationRef class-attribute instance-attribute

operationRef = None

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 instance-attribute

description

headers class-attribute instance-attribute

headers = None

content class-attribute instance-attribute

content = None

links class-attribute instance-attribute

links = None

Config

extra class-attribute instance-attribute

extra = 'allow'

Operation

ベース: BaseModelWithConfig

model_config class-attribute instance-attribute

model_config = {'extra': 'allow'}

tags class-attribute instance-attribute

tags = None

summary class-attribute instance-attribute

summary = None

description class-attribute instance-attribute

description = None

externalDocs class-attribute instance-attribute

externalDocs = None

operationId class-attribute instance-attribute

operationId = None

parameters class-attribute instance-attribute

parameters = None

requestBody class-attribute instance-attribute

requestBody = None

responses class-attribute instance-attribute

responses = None

callbacks class-attribute instance-attribute

callbacks = None

deprecated class-attribute instance-attribute

deprecated = None

security class-attribute instance-attribute

security = None

servers class-attribute instance-attribute

servers = None

Config

extra class-attribute instance-attribute

extra = 'allow'

PathItem

ベース: BaseModelWithConfig

model_config class-attribute instance-attribute

model_config = {'extra': 'allow'}

ref class-attribute instance-attribute

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

summary class-attribute instance-attribute

summary = None

description class-attribute instance-attribute

description = None

get class-attribute instance-attribute

get = None

put class-attribute instance-attribute

put = None

post class-attribute instance-attribute

post = None

delete class-attribute instance-attribute

delete = None

options class-attribute instance-attribute

options = None

head class-attribute instance-attribute

head = None

patch class-attribute instance-attribute

patch = None

trace class-attribute instance-attribute

trace = None

servers class-attribute instance-attribute

servers = None

parameters class-attribute instance-attribute

parameters = None

Config

extra class-attribute instance-attribute

extra = 'allow'

SecuritySchemeType

ベース: Enum

apiKey class-attribute instance-attribute

apiKey = 'apiKey'

http class-attribute instance-attribute

http = 'http'

oauth2 class-attribute instance-attribute

oauth2 = 'oauth2'

openIdConnect class-attribute instance-attribute

openIdConnect = 'openIdConnect'

SecurityBase

ベース: BaseModelWithConfig

model_config class-attribute instance-attribute

model_config = {'extra': 'allow'}

type_ class-attribute instance-attribute

type_ = Field(alias='type')

description class-attribute instance-attribute

description = None

Config

extra class-attribute instance-attribute

extra = 'allow'

APIKeyIn

ベース: Enum

query class-attribute instance-attribute

query = 'query'

header class-attribute instance-attribute

header = 'header'

cookie class-attribute instance-attribute

cookie = 'cookie'

APIKey

ベース: SecurityBase

model_config class-attribute instance-attribute

model_config = {'extra': 'allow'}

description class-attribute instance-attribute

description = None

type_ class-attribute instance-attribute

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

in_ class-attribute instance-attribute

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 class-attribute instance-attribute

requestBodies = None

headers class-attribute instance-attribute

headers = None

securitySchemes class-attribute instance-attribute

securitySchemes = None

links class-attribute instance-attribute

links = None

callbacks class-attribute instance-attribute

callbacks = None

pathItems class-attribute instance-attribute

pathItems = None

Config

extra class-attribute instance-attribute

extra = 'allow'

Tag

ベース: BaseModelWithConfig

model_config class-attribute instance-attribute

model_config = {'extra': 'allow'}

name instance-attribute

name

description class-attribute instance-attribute

description = None

externalDocs class-attribute instance-attribute

externalDocs = None

Config

extra class-attribute instance-attribute

extra = 'allow'

OpenAPI

ベース: BaseModelWithConfig

model_config class-attribute instance-attribute

model_config = {'extra': 'allow'}

openapi instance-attribute

openapi

info instance-attribute

info

jsonSchemaDialect class-attribute instance-attribute

jsonSchemaDialect = None

servers class-attribute instance-attribute

servers = None

paths class-attribute instance-attribute

paths = None

webhooks class-attribute instance-attribute

webhooks = None

components class-attribute instance-attribute

components = None

security class-attribute instance-attribute

security = None

tags class-attribute instance-attribute

tags = None

externalDocs class-attribute instance-attribute

externalDocs = None

Config

extra class-attribute instance-attribute

extra = 'allow'