🐛 Fix generate_unique_id to produce consistent IDs for operations with multiple methods
#13861
Conversation
generate_unique_id to produce consistent IDs for operations with multiple methods
|
@mohiuddin-khan-shiam, thanks for your interest in FastAPI! I just found similar PR. It was rejected with the reason:
So, the proposed solution is to avoid using @app.put("/")
@app.post("/")
async def po() -> MyModel:
return {} |
|
Hi @tiangolo, @YuriiMotov , I've noticed that multiple users have created issues or PRs (like #4851 and #13861) related to using To help reduce future duplicates and improve the DX (developer experience), I'd like to propose adding a clear subsection in the documentation, either under:
This subsection would clarify that FastAPI does not officially support multiple HTTP methods on a single function, even if Starlette does. Instead, users should define each method with its own decorator. For example: ❌ Don't do this: @app.api_route("/items/", methods=["GET", "POST"])
async def get_or_create_item():
...✅ Do this instead: @app.get("/items/")
async def read_items():
return [{"item_id": "Foo"}]
@app.post("/items/")
async def create_item():
return {"item_id": "Foo", "status": "created"}Even if both routes share logic, users can extract it into a helper function to stay consistent with FastAPI's OpenAPI handling. Let me know if you're open to a PR for this! I’d be happy to contribute the exact wording and placement based on your preferences. Thanks for the awesome framework 🙌 |
|
@Pavanmanikanta98, I think we need such PR. I can't guarantee it will be merged, but I will support it. Just one thing. I would implement the code example as one endpoint function with 2 path decorators. @app.put("/")
@app.post("/")
async def po(request: Request):
if reques.method == "PUT":
# Do something
else:
# Do something else
return {}I would also add docstring to |
Description
generate_unique_id picked
list(route.methods)[0], which depends on the internal,non-deterministic order of a
set.The resulting
operationIds could oscillate between launches (e.g.get_items_getvs
get_items_post), breaking caches and client generation.The fix sorts the HTTP methods first and then selects the first value, ensuring a
stable, predictable
operationIdacross runs while preserving the original logic.