Open l7wei opened 6 months ago
DeprecationWarning: `example` has been deprecated, please use `examples` instead
雖然 example
已經被棄用了,但感覺是最符合目前情況的用法,因為它會精簡的顯示在欄位上:
新的 examples
會在 openapi.json
做更恰當的註記,但 Swagger UI 並不會顯示出來:
(略)
"/buses/stops/{stop_name}/{bus_type}/{day}/{direction}": {
"get": {
"tags": [
"Buses"
],
"summary": "Get Stop Up",
"description": "取得公車站牌停靠公車資訊。",
"operationId": "get_stop_up_buses_stops__stop_name___bus_type___day___direction__get",
"parameters": [
{
"name": "stop_name",
"in": "path",
"required": true,
"schema": {
"allOf": [
{
"$ref": "#/components/schemas/StopsName"
}
],
"description": "公車站牌名稱",
"examples": [
"台積館"
],
"title": "Stop Name"
},
"description": "公車站牌名稱"
},
(略)
而使用可正常顯示的參數 openapi_examples
又顯得下拉式選單過於冗餘,因為多數情況下範例只會有一個:
fastapi 的作者也有就這個議題做過回應:ref
Some unexpected warning showed during test.