如果路径相同，则忽略其中一个路径操作，但其中一个具有查询参数

Question

我想要两个具有相同路径的路径操作@app.get("/movies/", ..) ：

@app.get("/movies/", response_model=schemas.Movie)
def read_movie_by_title(title: str, db: Session = Depends(get_db)):
    db_movie = crud.get_movie_by_title(db, title=title)
    return db_movie


@app.get("/movies/", response_model=List[schemas.Movie])
def read_movies(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)):
    db_movies = crud.get_movies(db, skip=skip, limit=limit)
    return db_movies

如您所见，第一个用于通过标题获取电影并具有查询参数（ title ），第二个用于获取列表。 当我检查生成的文档时，缺少read_movie_by_title的文档。

我试图通过删除/将read_movie_by_title的路径更改为/movies来解决这个问题，但我根本不喜欢这个解决方案。

所以问题是：有没有办法让两条相等的路径，但一条带有查询参数，还是我需要以不同的方式来做这件事？ 有什么建议么？

Answer 1

您可以通过将端点更改为"/movies/{title}"来使用路径参数而不是第一个查询参数：

@app.get("/movies/{title}", response_model=schemas.Movie)
def read_movie_by_title(title: str, db: Session = Depends(get_db)):
    db_movie = crud.get_movie_by_title(db, title=title)
    return db_movie

# 2nd remains the same
@app.get("/movies/", response_model=List[schemas.Movie])
def read_movies(skip: int = 0, limit: int = 100, db: Session = Depends(get_db)):
    db_movies = crud.get_movies(db, skip=skip, limit=limit)
    return db_movies

Answer 2

您的问题的答案（有没有办法拥有两条相等的路径，但一条带有查询参数）是否，区分路径的唯一方法是通过其方法（ GET, PUT, POST, DELETE, ... ）。

但是，您确实有多种方法可以实现您想要的结果。

REST方法

标准的REST方法是为基于标题的检索定义不同的路径，例如/movies/{title} ，就像路径参数@FastAPI文档中显示的第一个示例一样。

如果您想实现search功能而不是retrieval by unique title ，您可以执行以下操作：

@app.get("/movies", response_model=List[schemas.Movie])
def read_movies(title: Optional[str] = None, skip: int = 0, limit: int = 100, db: Session = Depends(get_db)):
    # list of filters
    filters = []
    if title: # if it's not none
        filters.append(models.Movie.title.ilike(f"%{title}%"))
    
    db_movies = crud.get_movies(db, filters=filters, skip=skip, limit=limit)
    return db_movies

在你的 crud 操作中，你会查询它：

    return session.query(models.Movie).filter(*filters).all()

用一种方法做你想做的更简单的方法

@app.get("/movies", response_model=List[schemas.Movie])
def read_movies(title: Optional[str] = None, skip: int = 0, limit: int = 100, db: Session = Depends(get_db)):
    if title: # if it's not none
        return crud.get_movie_by_title(db, title=title)
    
    return crud.get_movies(db, filters=filters, skip=skip, limit=limit)

尽管后者可能会使 API 的消费者感到困惑，因此REST方法将是最推荐的方法。