{"detail":[{"type":"int_parsing","loc":["path","item_id"],"msg":"Input should be a valid integer, unable to parse string as an integer","input":"foo"}]}
потому что параметр пути item_id имел значение "foo", которое не является int.
И когда вы откроете браузер по адресу http://127.0.0.1:8000/docs, вы увидите автоматическую интерактивную документацию API, подобную этой:
Совет
Опять же, просто с тем же объявлением типа Python FastAPI предоставляет автоматическую интерактивную документацию (интегрирующую Swagger UI).
Обратите внимание, что параметр пути объявлен как целое число.
Преимущества, основанные на стандартах, альтернативная документация¶
И поскольку сгенерированная схема основана на стандарте OpenAPI, существует множество совместимых инструментов.
Благодаря этому FastAPI сам предоставляет альтернативную документацию API (с использованием ReDoc), которую вы можете открыть по адресу http://127.0.0.1:8000/redoc:
Таким же образом существует множество совместимых инструментов, включая инструменты генерации кода для многих языков.
При создании операций пути вы можете столкнуться с ситуациями, когда у вас есть фиксированный путь.
Например, /users/me — допустим, это для получения данных о текущем пользователе.
И у вас также может быть путь /users/{user_id} для получения данных о конкретном пользователе по его ID.
Поскольку операции пути выполняются по порядку, необходимо убедиться, что путь /users/me объявлен раньше, чем /users/{user_id}:
fromfastapiimportFastAPIapp=FastAPI()@app.get("/users/me")asyncdefread_user_me():return{"user_id":"the current user"}@app.get("/users/{user_id}")asyncdefread_user(user_id:str):return{"user_id":user_id}
В противном случае путь /users/{user_id} будет соответствовать и /users/me, "думая", что он получает параметр user_id со значением "me".
Аналогично, вы не можете переопределить операцию пути:
Если у вас есть операция пути, которая принимает параметр пути, но вы хотите, чтобы возможные допустимые значения параметра пути были предопределены, вы можете использовать стандартный Python Enum.
Импортируйте Enum и создайте подкласс, наследующий от str и Enum.
Наследуя от str, документация API сможет знать, что значения должны быть типа string, и сможет правильно их отображать.
Затем создайте атрибуты класса с фиксированными значениями, которые и будут допустимыми значениями:
fromenumimportEnumfromfastapiimportFastAPIclassModelName(str,Enum):alexnet="alexnet"resnet="resnet"lenet="lenet"app=FastAPI()@app.get("/models/{model_name}")asyncdefget_model(model_name:ModelName):ifmodel_nameisModelName.alexnet:return{"model_name":model_name,"message":"Deep Learning FTW!"}ifmodel_name.value=="lenet":return{"model_name":model_name,"message":"LeCNN all the images"}return{"model_name":model_name,"message":"Have some residuals"}
Совет
Если вам интересно, "AlexNet", "ResNet" и "LeNet" — это просто названия архитектур моделей машинного обучения.
Затем создайте параметр пути с аннотацией типа, используя созданный вами класс перечисления (ModelName):
fromenumimportEnumfromfastapiimportFastAPIclassModelName(str,Enum):alexnet="alexnet"resnet="resnet"lenet="lenet"app=FastAPI()@app.get("/models/{model_name}")asyncdefget_model(model_name:ModelName):ifmodel_nameisModelName.alexnet:return{"model_name":model_name,"message":"Deep Learning FTW!"}ifmodel_name.value=="lenet":return{"model_name":model_name,"message":"LeCNN all the images"}return{"model_name":model_name,"message":"Have some residuals"}
Вы можете сравнивать его с элементом перечисления в созданном вами перечислении ModelName:
fromenumimportEnumfromfastapiimportFastAPIclassModelName(str,Enum):alexnet="alexnet"resnet="resnet"lenet="lenet"app=FastAPI()@app.get("/models/{model_name}")asyncdefget_model(model_name:ModelName):ifmodel_nameisModelName.alexnet:return{"model_name":model_name,"message":"Deep Learning FTW!"}ifmodel_name.value=="lenet":return{"model_name":model_name,"message":"LeCNN all the images"}return{"model_name":model_name,"message":"Have some residuals"}
Вы можете получить фактическое значение (в данном случае str) с помощью model_name.value или, в общем случае, your_enum_member.value:
fromenumimportEnumfromfastapiimportFastAPIclassModelName(str,Enum):alexnet="alexnet"resnet="resnet"lenet="lenet"app=FastAPI()@app.get("/models/{model_name}")asyncdefget_model(model_name:ModelName):ifmodel_nameisModelName.alexnet:return{"model_name":model_name,"message":"Deep Learning FTW!"}ifmodel_name.value=="lenet":return{"model_name":model_name,"message":"LeCNN all the images"}return{"model_name":model_name,"message":"Have some residuals"}
Совет
Вы также можете получить доступ к значению "lenet" с помощью ModelName.lenet.value.
Вы можете возвращать элементы перечисления из вашей операции пути, даже вложенные в JSON-тело (например, dict).
Они будут преобразованы в соответствующие значения (в данном случае строки) перед возвратом клиенту:
fromenumimportEnumfromfastapiimportFastAPIclassModelName(str,Enum):alexnet="alexnet"resnet="resnet"lenet="lenet"app=FastAPI()@app.get("/models/{model_name}")asyncdefget_model(model_name:ModelName):ifmodel_nameisModelName.alexnet:return{"model_name":model_name,"message":"Deep Learning FTW!"}ifmodel_name.value=="lenet":return{"model_name":model_name,"message":"LeCNN all the images"}return{"model_name":model_name,"message":"Have some residuals"}
OpenAPI не поддерживает способ объявления параметра пути, содержащего внутри путь, так как это может привести к сценариям, которые сложно тестировать и определять.
Тем не менее, вы все равно можете сделать это в FastAPI, используя один из внутренних инструментов Starlette.
И документация будет работать, хотя и не будет добавлять никаких указаний на то, что параметр должен содержать путь.