Home / File/ tutorial003_py39.py — fastapi Source File

tutorial003_py39.py — fastapi Source File

Architecture documentation for tutorial003_py39.py, a python file in the fastapi codebase. 3 imports, 1 dependents.

File python FastAPI Responses 3 imports 1 dependents 1 functions 2 classes

Entity Profile

Dependency Diagram

graph LR
  21b708b8_ccef_6041_0f86_9c9d59b4933f["tutorial003_py39.py"]
  534f6e44_61b8_3c38_8b89_6934a6df9802["__init__.py"]
  21b708b8_ccef_6041_0f86_9c9d59b4933f --> 534f6e44_61b8_3c38_8b89_6934a6df9802
  967b6712_70e2_f5fa_f671_7c149857a445["responses.py"]
  21b708b8_ccef_6041_0f86_9c9d59b4933f --> 967b6712_70e2_f5fa_f671_7c149857a445
  6913fbd4_39df_d14b_44bb_522e99b65b90["pydantic"]
  21b708b8_ccef_6041_0f86_9c9d59b4933f --> 6913fbd4_39df_d14b_44bb_522e99b65b90
  1e6bb65a_a1f5_e88e_239d_4eab6a7b8a05["test_tutorial003.py"]
  1e6bb65a_a1f5_e88e_239d_4eab6a7b8a05 --> 21b708b8_ccef_6041_0f86_9c9d59b4933f
  style 21b708b8_ccef_6041_0f86_9c9d59b4933f fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

from fastapi import FastAPI
from fastapi.responses import JSONResponse
from pydantic import BaseModel


class Item(BaseModel):
    id: str
    value: str


class Message(BaseModel):
    message: str


app = FastAPI()


@app.get(
    "/items/{item_id}",
    response_model=Item,
    responses={
        404: {"model": Message, "description": "The item was not found"},
        200: {
            "description": "Item requested by ID",
            "content": {
                "application/json": {
                    "example": {"id": "bar", "value": "The bar tenders"}
                }
            },
        },
    },
)
async def read_item(item_id: str):
    if item_id == "foo":
        return {"id": "foo", "value": "there goes my hero"}
    else:
        return JSONResponse(status_code=404, content={"message": "Item not found"})

Domain

Subdomains

Functions

Classes

Dependencies

Frequently Asked Questions

What does tutorial003_py39.py do?
tutorial003_py39.py is a source file in the fastapi codebase, written in python. It belongs to the FastAPI domain, Responses subdomain.
What functions are defined in tutorial003_py39.py?
tutorial003_py39.py defines 1 function(s): read_item.
What does tutorial003_py39.py depend on?
tutorial003_py39.py imports 3 module(s): __init__.py, pydantic, responses.py.
What files import tutorial003_py39.py?
tutorial003_py39.py is imported by 1 file(s): test_tutorial003.py.
Where is tutorial003_py39.py in the architecture?
tutorial003_py39.py is located at docs_src/additional_responses/tutorial003_py39.py (domain: FastAPI, subdomain: Responses, directory: docs_src/additional_responses).

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free