Package: openapi-schema-pydantic
openapi-schema-pydanticOpenAPI (v3) specification schema asPydanticclasses.The naming of the classes follows the schema inOpenAPI specification.Installationpip install openapi-schema-pydanticTry mefromopenapi_schema_pydanticimportOpenAPI,Info,PathItem,Operation,Response# Construct OpenAPI by pydantic objectsopen_api=OpenAPI(info=Info(title="My own API",version="v0.0.1",),paths={"/ping":PathItem(get=Operation(responses={"200":Response(description="pong")}))},)print(open_api.json(by_alias=True,exclude_none=True,indent=2))Result:{"openapi":"3.1.0","info":{"title":"My own API","version":"v0.0.1"},"servers":[{"url":"/"}],"paths":{"/ping":{"get":{"responses":{"200":{"description":"pong"}},"deprecated":false}}}}Take advantage of PydanticPydantic is a great tool, allow you to use object / dict / mixed data for for input.The following examples give the same OpenAPI result as above:fromopenapi_schema_pydanticimportOpenAPI,PathItem,Response# Construct OpenAPI from dictopen_api=OpenAPI.parse_obj({"info":{"title":"My own API","version":"v0.0.1"},"paths":{"/ping":{"get":{"responses":{"200":{"description":"pong"}}}}},})# Construct OpenAPI with mix of dict/objectopen_api=OpenAPI.parse_obj({"info":{"title":"My own API","version":"v0.0.1"},"paths":{"/ping":PathItem(get={"responses":{"200":Response(description="pong")}})},})Use Pydantic classes as schemaTheSchema Objectin OpenAPI has definitions and tweaks in JSON Schema, which is hard to comprehend and define a good data classPydantic already has a good way tocreate JSON schema,
let's not re-invent the wheelThe approach to deal with this:UsePydanticSchemaobjects to represent theSchemainOpenAPIobjectInvokeconstruct_open_api_with_schema_classto resolve the JSON schemas and referencesfrompydanticimportBaseModel,Fieldfromopenapi_schema_pydanticimportOpenAPIfromopenapi_schema_pydantic.utilimportPydanticSchema,construct_open_api_with_schema_classdefconstruct_base_open_api()->OpenAPI:returnOpenAPI.parse_obj({"info":{"title":"My own API","version":"v0.0.1"},"paths":{"/ping":{"post":{"requestBody":{"content":{"application/json":{"schema":PydanticSchema(schema_class=PingRequest)}}},"responses":{"200":{"description":"pong","content":{"application/json":{"schema":PydanticSchema(schema_class=PingResponse)}},}},}}},})classPingRequest(BaseModel):"""Ping Request"""req_foo:str=Field(description="foo value of the request")req_bar:str=Field(description="bar value of the request")classPingResponse(BaseModel):"""Ping response"""resp_foo:str=Field(description="foo value of the response")resp_bar:str=Field(description="bar value of the response")open_api=construct_base_open_api()open_api=construct_open_api_with_schema_class(open_api)# print the result openapi.jsonprint(open_api.json(by_alias=True,exclude_none=True,indent=2))Result:{"openapi":"3.1.0","info":{"title":"My own API","version":"v0.0.1"},"servers":[{"url":"/"}],"paths":{"/ping":{"post":{"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PingRequest"}}},"required":false},"responses":{"200":{"description":"pong","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PingResponse"}}}}},"deprecated":false}}},"components":{"schemas":{"PingRequest":{"title":"PingRequest","required":["req_foo","req_bar"],"type":"object","properties":{"req_foo":{"title":"Req Foo","type":"string","description":"foo value of the request"},"req_bar":{"title":"Req Bar","type":"string","description":"bar value of the request"}},"description":"Ping Request"},"PingResponse":{"title":"PingResponse","required":["resp_foo","resp_bar"],"type":"object","properties":{"resp_foo":{"title":"Resp Foo","type":"string","description":"foo value of the response"},"resp_bar":{"title":"Resp Bar","type":"string","description":"bar value of the response"}},"description":"Ping response"}}}}NotesUse of OpenAPI.json() / OpenAPI.dict()When usingOpenAPI.json()/OpenAPI.dict()function,
argumentsby_alias=True, exclude_none=Truehas to be in place.
Otherwise the result json will not fit the OpenAPI standard.# OKopen_api.json(by_alias=True,exclude_none=True,indent=2)# Not goodopen_api.json(indent=2)More info about field alias:OpenAPI versionField alias info3.1.0here3.0.3hereNon-pydantic schema typesSome schema types are not implemented as pydantic classes.
Please refer to the following for more info:OpenAPI versionNon-pydantic schema type info3.1.0here3.0.3hereUse OpenAPI 3.0.3 instead of 3.1.0Some UI renderings (e.g. Swagger) still do not support OpenAPI 3.1.0.
It is allowed to use the old 3.0.3 version by importing from different paths:fromopenapi_schema_pydantic.v3.v3_0_3importOpenAPI,...fromopenapi_schema_pydantic.v3.v3_0_3.utilimportPydanticSchema,construct_open_api_with_schema_classLicenseMIT License