Movatterモバイル変換


[0]ホーム

URL:


Ana içeriğe geç
Join theFastAPI Cloud waiting list 🚀
Follow@fastapi onX (Twitter) to stay updated
FollowFastAPI onLinkedIn to stay updated
Subscribe to theFastAPI and friends newsletter 🎉
sponsor
sponsor
sponsor
sponsor
sponsor
sponsor
sponsor
sponsor
sponsor
sponsor
sponsor

OpenAPImodels

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

fastapi.openapi.models

SchemaTypemodule-attribute

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

SchemaOrBoolmodule-attribute

SchemaOrBool=Schema|bool

SecuritySchememodule-attribute

BaseModelWithConfig

Bases:BaseModel

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

Contact

Bases:BaseModelWithConfig

nameclass-attributeinstance-attribute

name=None

urlclass-attributeinstance-attribute

url=None

emailclass-attributeinstance-attribute

email=None

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

License

Bases:BaseModelWithConfig

nameinstance-attribute

name

identifierclass-attributeinstance-attribute

identifier=None

urlclass-attributeinstance-attribute

url=None

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

Info

Bases:BaseModelWithConfig

titleinstance-attribute

title

summaryclass-attributeinstance-attribute

summary=None

descriptionclass-attributeinstance-attribute

description=None

termsOfServiceclass-attributeinstance-attribute

termsOfService=None

contactclass-attributeinstance-attribute

contact=None

licenseclass-attributeinstance-attribute

license=None

versioninstance-attribute

version

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

ServerVariable

Bases:BaseModelWithConfig

enumclass-attributeinstance-attribute

enum=None

defaultinstance-attribute

default

descriptionclass-attributeinstance-attribute

description=None

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

Server

Bases:BaseModelWithConfig

urlinstance-attribute

url

descriptionclass-attributeinstance-attribute

description=None

variablesclass-attributeinstance-attribute

variables=None

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

Reference

Bases:BaseModel

refclass-attributeinstance-attribute

ref=Field(alias='$ref')

Discriminator

Bases:BaseModel

propertyNameinstance-attribute

propertyName

mappingclass-attributeinstance-attribute

mapping=None

XML

Bases:BaseModelWithConfig

nameclass-attributeinstance-attribute

name=None

namespaceclass-attributeinstance-attribute

namespace=None

prefixclass-attributeinstance-attribute

prefix=None

attributeclass-attributeinstance-attribute

attribute=None

wrappedclass-attributeinstance-attribute

wrapped=None

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

ExternalDocumentation

Bases:BaseModelWithConfig

descriptionclass-attributeinstance-attribute

description=None

urlinstance-attribute

url

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

Schema

Bases:BaseModelWithConfig

schema_class-attributeinstance-attribute

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

vocabularyclass-attributeinstance-attribute

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

idclass-attributeinstance-attribute

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

anchorclass-attributeinstance-attribute

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

dynamicAnchorclass-attributeinstance-attribute

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

refclass-attributeinstance-attribute

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

dynamicRefclass-attributeinstance-attribute

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

defsclass-attributeinstance-attribute

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

commentclass-attributeinstance-attribute

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

allOfclass-attributeinstance-attribute

allOf=None

anyOfclass-attributeinstance-attribute

anyOf=None

oneOfclass-attributeinstance-attribute

oneOf=None

not_class-attributeinstance-attribute

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

if_class-attributeinstance-attribute

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

thenclass-attributeinstance-attribute

then=None

else_class-attributeinstance-attribute

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

dependentSchemasclass-attributeinstance-attribute

dependentSchemas=None

prefixItemsclass-attributeinstance-attribute

prefixItems=None

itemsclass-attributeinstance-attribute

items=None

containsclass-attributeinstance-attribute

contains=None

propertiesclass-attributeinstance-attribute

properties=None

patternPropertiesclass-attributeinstance-attribute

patternProperties=None

additionalPropertiesclass-attributeinstance-attribute

additionalProperties=None

propertyNamesclass-attributeinstance-attribute

propertyNames=None

unevaluatedItemsclass-attributeinstance-attribute

unevaluatedItems=None

unevaluatedPropertiesclass-attributeinstance-attribute

unevaluatedProperties=None

typeclass-attributeinstance-attribute

type=None

enumclass-attributeinstance-attribute

enum=None

constclass-attributeinstance-attribute

const=None

multipleOfclass-attributeinstance-attribute

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

maximumclass-attributeinstance-attribute

maximum=None

exclusiveMaximumclass-attributeinstance-attribute

exclusiveMaximum=None

minimumclass-attributeinstance-attribute

minimum=None

exclusiveMinimumclass-attributeinstance-attribute

exclusiveMinimum=None

maxLengthclass-attributeinstance-attribute

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

minLengthclass-attributeinstance-attribute

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

patternclass-attributeinstance-attribute

pattern=None

maxItemsclass-attributeinstance-attribute

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

minItemsclass-attributeinstance-attribute

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

uniqueItemsclass-attributeinstance-attribute

uniqueItems=None

maxContainsclass-attributeinstance-attribute

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

minContainsclass-attributeinstance-attribute

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

maxPropertiesclass-attributeinstance-attribute

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

minPropertiesclass-attributeinstance-attribute

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

requiredclass-attributeinstance-attribute

required=None

dependentRequiredclass-attributeinstance-attribute

dependentRequired=None

formatclass-attributeinstance-attribute

format=None

contentEncodingclass-attributeinstance-attribute

contentEncoding=None

contentMediaTypeclass-attributeinstance-attribute

contentMediaType=None

contentSchemaclass-attributeinstance-attribute

contentSchema=None

titleclass-attributeinstance-attribute

title=None

descriptionclass-attributeinstance-attribute

description=None

defaultclass-attributeinstance-attribute

default=None

deprecatedclass-attributeinstance-attribute

deprecated=None

readOnlyclass-attributeinstance-attribute

readOnly=None

writeOnlyclass-attributeinstance-attribute

writeOnly=None

examplesclass-attributeinstance-attribute

examples=None

discriminatorclass-attributeinstance-attribute

discriminator=None

xmlclass-attributeinstance-attribute

xml=None

externalDocsclass-attributeinstance-attribute

externalDocs=None

exampleclass-attributeinstance-attribute

example=None
Deprecated in OpenAPI 3.1.0 that now uses JSON Schema 2020-12, although still supported. Use examples instead.

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

Example

Bases:TypedDict

summaryinstance-attribute

summary

descriptioninstance-attribute

description

valueinstance-attribute

value

externalValueinstance-attribute

externalValue

ParameterInType

Bases:Enum

queryclass-attributeinstance-attribute

query='query'

headerclass-attributeinstance-attribute

header='header'

pathclass-attributeinstance-attribute

path='path'

cookieclass-attributeinstance-attribute

cookie='cookie'

Encoding

Bases:BaseModelWithConfig

contentTypeclass-attributeinstance-attribute

contentType=None

headersclass-attributeinstance-attribute

headers=None

styleclass-attributeinstance-attribute

style=None

explodeclass-attributeinstance-attribute

explode=None

allowReservedclass-attributeinstance-attribute

allowReserved=None

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

MediaType

Bases:BaseModelWithConfig

schema_class-attributeinstance-attribute

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

exampleclass-attributeinstance-attribute

example=None

examplesclass-attributeinstance-attribute

examples=None

encodingclass-attributeinstance-attribute

encoding=None

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

ParameterBase

Bases:BaseModelWithConfig

descriptionclass-attributeinstance-attribute

description=None

requiredclass-attributeinstance-attribute

required=None

deprecatedclass-attributeinstance-attribute

deprecated=None

styleclass-attributeinstance-attribute

style=None

explodeclass-attributeinstance-attribute

explode=None

allowReservedclass-attributeinstance-attribute

allowReserved=None

schema_class-attributeinstance-attribute

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

exampleclass-attributeinstance-attribute

example=None

examplesclass-attributeinstance-attribute

examples=None

contentclass-attributeinstance-attribute

content=None

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

Parameter

Bases:ParameterBase

nameinstance-attribute

name

in_class-attributeinstance-attribute

in_=Field(alias='in')

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

descriptionclass-attributeinstance-attribute

description=None

requiredclass-attributeinstance-attribute

required=None

deprecatedclass-attributeinstance-attribute

deprecated=None

styleclass-attributeinstance-attribute

style=None

explodeclass-attributeinstance-attribute

explode=None

allowReservedclass-attributeinstance-attribute

allowReserved=None

schema_class-attributeinstance-attribute

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

exampleclass-attributeinstance-attribute

example=None

examplesclass-attributeinstance-attribute

examples=None

contentclass-attributeinstance-attribute

content=None

Header

Bases:ParameterBase

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

descriptionclass-attributeinstance-attribute

description=None

requiredclass-attributeinstance-attribute

required=None

deprecatedclass-attributeinstance-attribute

deprecated=None

styleclass-attributeinstance-attribute

style=None

explodeclass-attributeinstance-attribute

explode=None

allowReservedclass-attributeinstance-attribute

allowReserved=None

schema_class-attributeinstance-attribute

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

exampleclass-attributeinstance-attribute

example=None

examplesclass-attributeinstance-attribute

examples=None

contentclass-attributeinstance-attribute

content=None

RequestBody

Bases:BaseModelWithConfig

descriptionclass-attributeinstance-attribute

description=None

contentinstance-attribute

content

requiredclass-attributeinstance-attribute

required=None

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

Link

Bases:BaseModelWithConfig

operationRefclass-attributeinstance-attribute

operationRef=None

operationIdclass-attributeinstance-attribute

operationId=None

parametersclass-attributeinstance-attribute

parameters=None

requestBodyclass-attributeinstance-attribute

requestBody=None

descriptionclass-attributeinstance-attribute

description=None

serverclass-attributeinstance-attribute

server=None

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

Response

Bases:BaseModelWithConfig

descriptioninstance-attribute

description

headersclass-attributeinstance-attribute

headers=None

contentclass-attributeinstance-attribute

content=None

linksclass-attributeinstance-attribute

links=None

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

Operation

Bases:BaseModelWithConfig

tagsclass-attributeinstance-attribute

tags=None

summaryclass-attributeinstance-attribute

summary=None

descriptionclass-attributeinstance-attribute

description=None

externalDocsclass-attributeinstance-attribute

externalDocs=None

operationIdclass-attributeinstance-attribute

operationId=None

parametersclass-attributeinstance-attribute

parameters=None

requestBodyclass-attributeinstance-attribute

requestBody=None

responsesclass-attributeinstance-attribute

responses=None

callbacksclass-attributeinstance-attribute

callbacks=None

deprecatedclass-attributeinstance-attribute

deprecated=None

securityclass-attributeinstance-attribute

security=None

serversclass-attributeinstance-attribute

servers=None

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

PathItem

Bases:BaseModelWithConfig

refclass-attributeinstance-attribute

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

summaryclass-attributeinstance-attribute

summary=None

descriptionclass-attributeinstance-attribute

description=None

getclass-attributeinstance-attribute

get=None

putclass-attributeinstance-attribute

put=None

postclass-attributeinstance-attribute

post=None

deleteclass-attributeinstance-attribute

delete=None

optionsclass-attributeinstance-attribute

options=None

headclass-attributeinstance-attribute

head=None

patchclass-attributeinstance-attribute

patch=None

traceclass-attributeinstance-attribute

trace=None

serversclass-attributeinstance-attribute

servers=None

parametersclass-attributeinstance-attribute

parameters=None

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

SecuritySchemeType

Bases:Enum

apiKeyclass-attributeinstance-attribute

apiKey='apiKey'

httpclass-attributeinstance-attribute

http='http'

oauth2class-attributeinstance-attribute

oauth2='oauth2'

openIdConnectclass-attributeinstance-attribute

openIdConnect='openIdConnect'

SecurityBase

Bases:BaseModelWithConfig

type_class-attributeinstance-attribute

type_=Field(alias='type')

descriptionclass-attributeinstance-attribute

description=None

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

APIKeyIn

Bases:Enum

queryclass-attributeinstance-attribute

query='query'

headerclass-attributeinstance-attribute

header='header'

cookieclass-attributeinstance-attribute

cookie='cookie'

APIKey

Bases:SecurityBase

type_class-attributeinstance-attribute

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

in_class-attributeinstance-attribute

in_=Field(alias='in')

nameinstance-attribute

name

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

descriptionclass-attributeinstance-attribute

description=None

HTTPBase

Bases:SecurityBase

type_class-attributeinstance-attribute

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

schemeinstance-attribute

scheme

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

descriptionclass-attributeinstance-attribute

description=None

HTTPBearer

Bases:HTTPBase

schemeclass-attributeinstance-attribute

scheme='bearer'

bearerFormatclass-attributeinstance-attribute

bearerFormat=None

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

type_class-attributeinstance-attribute

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

descriptionclass-attributeinstance-attribute

description=None

OAuthFlow

Bases:BaseModelWithConfig

refreshUrlclass-attributeinstance-attribute

refreshUrl=None

scopesclass-attributeinstance-attribute

scopes={}

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

OAuthFlowImplicit

Bases:OAuthFlow

authorizationUrlinstance-attribute

authorizationUrl

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

refreshUrlclass-attributeinstance-attribute

refreshUrl=None

scopesclass-attributeinstance-attribute

scopes={}

OAuthFlowPassword

Bases:OAuthFlow

tokenUrlinstance-attribute

tokenUrl

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

refreshUrlclass-attributeinstance-attribute

refreshUrl=None

scopesclass-attributeinstance-attribute

scopes={}

OAuthFlowClientCredentials

Bases:OAuthFlow

tokenUrlinstance-attribute

tokenUrl

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

refreshUrlclass-attributeinstance-attribute

refreshUrl=None

scopesclass-attributeinstance-attribute

scopes={}

OAuthFlowAuthorizationCode

Bases:OAuthFlow

authorizationUrlinstance-attribute

authorizationUrl

tokenUrlinstance-attribute

tokenUrl

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

refreshUrlclass-attributeinstance-attribute

refreshUrl=None

scopesclass-attributeinstance-attribute

scopes={}

OAuthFlows

Bases:BaseModelWithConfig

implicitclass-attributeinstance-attribute

implicit=None

passwordclass-attributeinstance-attribute

password=None

clientCredentialsclass-attributeinstance-attribute

clientCredentials=None

authorizationCodeclass-attributeinstance-attribute

authorizationCode=None

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

OAuth2

Bases:SecurityBase

type_class-attributeinstance-attribute

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

flowsinstance-attribute

flows

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

descriptionclass-attributeinstance-attribute

description=None

OpenIdConnect

Bases:SecurityBase

type_class-attributeinstance-attribute

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

openIdConnectUrlinstance-attribute

openIdConnectUrl

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

descriptionclass-attributeinstance-attribute

description=None

Components

Bases:BaseModelWithConfig

schemasclass-attributeinstance-attribute

schemas=None

responsesclass-attributeinstance-attribute

responses=None

parametersclass-attributeinstance-attribute

parameters=None

examplesclass-attributeinstance-attribute

examples=None

requestBodiesclass-attributeinstance-attribute

requestBodies=None

headersclass-attributeinstance-attribute

headers=None

securitySchemesclass-attributeinstance-attribute

securitySchemes=None

linksclass-attributeinstance-attribute

links=None

callbacksclass-attributeinstance-attribute

callbacks=None

pathItemsclass-attributeinstance-attribute

pathItems=None

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

Tag

Bases:BaseModelWithConfig

nameinstance-attribute

name

descriptionclass-attributeinstance-attribute

description=None

externalDocsclass-attributeinstance-attribute

externalDocs=None

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

OpenAPI

Bases:BaseModelWithConfig

openapiinstance-attribute

openapi

infoinstance-attribute

info

jsonSchemaDialectclass-attributeinstance-attribute

jsonSchemaDialect=None

serversclass-attributeinstance-attribute

servers=None

pathsclass-attributeinstance-attribute

paths=None

webhooksclass-attributeinstance-attribute

webhooks=None

componentsclass-attributeinstance-attribute

components=None

securityclass-attributeinstance-attribute

security=None

tagsclass-attributeinstance-attribute

tags=None

externalDocsclass-attributeinstance-attribute

externalDocs=None

model_configclass-attributeinstance-attribute

model_config={'extra':'allow'}

[8]ページ先頭

©2009-2026 Movatter.jp