I need to parse version parameter from URL path in FastAPI endpoint. The valid value for version parameter is either a fixed string e.g. active or any integer e.g. 1.
Is there an elegant way to make FastAPI or pydantic validate this path parameter with such rules so that I don't have to perform validation manually?
@app.get("/{version}")
def endpoint(version):
# version could be either 'active' or valid integer e.g. 1
return {"version": version}
What you are looking to do (have the choice between two types) is Union.
Example:
from typing import Union
from pydantic import BaseModel
class Version(BaseModel):
version: Union[int, str]
Warning ! Union tries to match the type of parameter to the given order of Union and stops at the first match, i.e. it will try in the example below, to find an INT first , then second, an STR. In some cases, this is of great importance.
Then comes the fact of wanting to have a fixed value. This is a Literal.
The Union and the Literal together would therefore give this:
from typing import Union, Literal
from pydantic import BaseModel
class Version(BaseModel):
version: Union[Literal['active'], int]
app.get decorator and in the function signature? def endpoint(version:Version)? def endpoint(version:Version.version) ? Something else?
def becomes def endpoint(version: Version):Version) and if it finds a field name that matches the argument name of the decorated function, it uses the type of that field to validate the url parameter. Am I correct? Thanks again.
from typing import Union, Literal,version: Union[Literal['active'], int]could work?