Tags
Note
This post is a thought. It's a short note that I make about someone else's
content online. Learn more about the process
thoughts
Here's my thought on 💭 Path Operation Advanced Configuration - FastAPI
Excluding routes from fastapi docs, can be done from the route configuration using `include_in_schema`. This is handy for routes that are not really api based or duplicates.
From the Docs
from fastapi import FastAPI app = FastAPI() @app.get("/items/", include_in_schema=False) async def read_items(): return [{"item_id": "Foo"}]
trailing slash
I've had better luck just routing both naked and trailing slash routes in fastapi. I've had api's deployed as a subroute to a site rather than a subdomain, and the automatic redirect betweens them tended to always get messed up. This is pretty easy fix for the pain is causes just give vim a yyp, and if you don't want deuplicates in your docs, ignore one.
from fastapi import FastAPI app = FastAPI() @app.get("/items") @app.get("/items/", include_in_schema=False) async def read_items(): return [{"item_id": "Foo"}]
favicon.ico
Now you do not need to deploy favicons to your api in any way, it is nice to have it in your browser tab, but more importantly to me I hate having console errors that are meaningless, this gives the browser something to automatically grab and not log errors.
@app.get("/favicon.ico", include_in_schema=False) def get_favicon(): return RedirectResponse(url="https://fokais.com/favicon.ico", status_code=status.HTTP_302_FOUND)
This post was a thought by Waylon Walker see all my thoughts at https://waylonwalker.com/thoughts