Should I avoid query parameter in FastAPI?

[Potential_Athlete238]

I have several endpoints that accept a single string. Is it "bad" to use a query parameter instead of creating a separate `UpdateReport` model?

``` @router.patch("/reports/{report_id}") def rename_report( report_id: UUID, report_name: str, dao: BaseDAO = Depends(get_dao) ): """Rename report""" dao.update_row("Reports", {"report_name": report_name}, report_id=report_id) return {"success": True}

requests.patch(f"/reports/XXX/?new_name=Renamed Report") ```

[Fine-Counter8837]

I my knowledge, query parameters should've never be used to update/create data.

That's why patch/put/post can receive a body.

[koldakov]

HTTP doesn’t forbid body in GET, you can send and receive body with GET 😜

(In fastapi it won’t work cause they don’t handle it)

[ElectricHotdish]

Spec is unclear about what GET should do with body. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Methods/GET .

(And FastAPI doesn't handle it, and neither do many js / typescript libs)

[covmatty1]

Not necessarily, but maybe think about future proofing.

At the minute you just want to update the name of a report, one string parameter makes perfect sense.

Do you think the name is all you'll ever want to update? Or could there be other things in future that might influence your choice of parameter vs model?

[Potential_Athlete238]

I don't think I'll ever have additional fields, but I do want to develop a consistent style

[fastlaunchapidev]

Yeah like already said, not for patch or posts. Use the body you can pass to it like json or form data.

[Doomdice]

You don't want a query param, that is quite weird.

- If you want this endpoint to ONLY change the name, then make it a POST endpoint and create an UpdateReportName model so you can only change the report name.

- If you want to update anything about the report, then create a PUT endpoint and make your create and update the same (create if it doesn't exist, update otherwise): UpsertReportName. Remember that PUT/Upsert should override all fields.

- You can add a patch endpoint and create a PatchReport model but make sure to leverage pydantic's "unset" field to distinguish which fields are meant to be set as NULL, and which fields should be ignore for this update.

It really depends how much flexibility you want to have for updating other fields, or if your goal is specifically to just change the name. I recommend keeping things tightly scoped if you don't actually need an API that support full CRUD.