Parameter na response_model yana bayyana nau'in amsa na endpoint. FastAPI yana amfani dashi don tabbatar da, tace, da shirya bayanan da aka dawo — kuma don rubutaccen amsa a cikin takamaiman API. Aikin da ya fi mahimmanci: tabbatar cewa kawai filayen da ake so ne ke fallasa (misali ba sa takaita kalmar wucewa ko kadan).
():
name:
email:
password:
() -> User:
db.get_user()
class UserOut(BaseModel): # the SAFE public shape — no password
name: str
email: str
@app.get("/users/{id}", response_model=UserOut)
def get_user(id: int):
return db.get_user(id) # returns a full user, but FastAPI FILTERS it to UserOut
# response → { "name": "...", "email": "..." } — password stripped automatically
Tare da response_model=UserOut, FastAPI yana ɗauka abin da ka dawo da shi kuma yana **tace shi" zuwa filayen kawai da aka bayyana a UserOut — sabili da haka kalmar wucewa (da duk wani filin da ya yafi) an cire shi daga amsa, koda kuwa ka dawo da babbar abu.
response_model yake yi✓ FILTERS the output to only the declared fields (key for hiding sensitive data)
✓ VALIDATES that your response matches the declared schema (catches mistakes)
✓ SERIALIZES the data to JSON correctly
✓ DOCUMENTS the response shape in the OpenAPI/Swagger docs
@app.get("/users/{id}")
def get_user(id: int) -> UserOut: # the -> return type works like response_model
return db.get_user(id)
# response_model_exclude_unset=True → omit fields not explicitly set
response_model yana mahimmanci don **tsaro" da kyakkyawan zane-zanen API.
Takardarsa mafi mahimmanci shine katawa kaiwa idan ba a niyata fitowa bayanan — ta hanyar bayyana daidai filayen da amsa ke kamata, FastAPI tana tace kome da ƙari (kamar haʃins kalmar wucewa, alamomi na ciki, ko alamar shiga) koda kuwa kodun ku dawo da babbar abu na jami'an yada, kaiwa rashin tare da tsaro.
Bayan haka, yana tabbatar da amsowa jiʻa ga bayani da aka bayyana (sayin kurakura inda ka dawo da nau'in mara yiwuwa), yana tabbatar da daidaitaccen shirya, kuma yana rubutaccen amsa a cikin takamaiman API amsowa wanda aka samar a kai tsaye.
Mukirki na amfani da abubuwan yada daban-daban da isassu (tare da response_model kan kontrol abin da ake fallasa) shi ne kyakkyawa hanya don tsaro, daidaitattun APIs, wanda ke sa ilimi na mahimmanci don kowane ma'ajiyar da take dawo da bayanan.