[QUESTION] Should a warning be raised when some routes can never be called ?

First check

• I added a very descriptive title to this issue.
• I used the GitHub search to find a similar issue and didn’t find it.
• I searched the FastAPI documentation, with the integrated search.
• I already searched in Google “How to X in FastAPI” and didn’t find any information.
• I already read and followed all the tutorial in the docs and didn’t find an answer.
• I already checked if it is not related to FastAPI but to Pydantic.
• I already checked if it is not related to FastAPI but to Swagger UI.
• I already checked if it is not related to FastAPI but to ReDoc.
• After submitting this, I commit to one of:
  • Read open issues with questions until I find 2 issues where I can help someone and add a comment to help there.
  • I already hit the “watch” button in this repository to receive notifications and I commit to help at least 2 people that ask questions in the future.
  • Implement a Pull Request for a confirmed bug.

Example

Here’s a self-contained, minimal, reproducible, example with my use case:

from fastapi import FastAPI

app = FastAPI()


@app.get("/user/{user}")
def read_user():
    return {"Hello": "World"}

@app.get("/user/me}")
def read_user_me():
   return {"Hello": "World": }

Description

According to https://fastapi.tiangolo.com/tutorial/path-params/?h=+order#order-matters the order of the routes matters. Ideally it’s a better practice to pay attention to the order, but one can sometimes make mistakes. In my example, the route /user/me will never be called.

It could maybe be interesting to raise a warning (or an Error?) to inform the user of this.

Environment

• OS: Windows

• FastAPI Version 0.60.0

• Python version: 3.8

[Tyrannas]

Totally right ! Thx @ycd , closing the issue 😃

[tiangolo]

Thanks for the help here @ycd ! 👏 🙇

Thanks for reporting back and closing the issue @Tyrannas 👍