status_code - Code Search

docs_src/custom_response/tutorial003_py310.py

        <head>
            <title>Some HTML in here</title>
        </head>
        <body>
            <h1>Look ma! HTML!</h1>
        </body>
    </html>
    """

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Thu Feb 12 13:19:43 GMT 2026

- 394 bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs_src/authentication_error_status_code/tutorial001_an_py310.py

app = FastAPI()


class HTTPBearer403(HTTPBearer):
    def make_not_authenticated_error(self) -> HTTPException:
        return HTTPException(
            status_code=status.HTTP_403_FORBIDDEN, detail="Not authenticated"
        )


CredentialsDep = Annotated[HTTPAuthorizationCredentials, Depends(HTTPBearer403())]


@app.get("/me")
def read_me(credentials: CredentialsDep):

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Thu Feb 12 13:19:43 GMT 2026

- 618 bytes

- Click Count (0)

github.com/tiangolo/fastapi

fastapi/applications.py

        app = FastAPI()

        @app.head("/items/", status_code=204)
        def get_items_headers(response: Response):
            response.headers["X-Cat-Dog"] = "Alone in the world"
        ```
        """
        return self.router.head(
            path,
            response_model=response_model,
            status_code=status_code,
            tags=tags,
            dependencies=dependencies,

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Wed Apr 01 16:16:24 GMT 2026

- 178.6K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/en/docs/advanced/additional-status-codes.md

To achieve that, import `JSONResponse`, and return your content there directly, setting the `status_code` that you want:

{* ../../docs_src/additional_status_codes/tutorial001_an_py310.py hl[4,25] *}

/// warning

When you return a `Response` directly, like in the example above, it will be returned directly.

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Thu Mar 05 18:13:19 GMT 2026

- 2K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs_src/handling_errors/tutorial003_py310.py

        self.name = name


app = FastAPI()


@app.exception_handler(UnicornException)
async def unicorn_exception_handler(request: Request, exc: UnicornException):
    return JSONResponse(
        status_code=418,
        content={"message": f"Oops! {exc.name} did something. There goes a rainbow..."},
    )


@app.get("/unicorns/{name}")
async def read_unicorn(name: str):
    if name == "yolo":

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Thu Feb 12 13:19:43 GMT 2026

- 626 bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/en/docs/advanced/response-change-status-code.md

## Use a `Response` parameter { #use-a-response-parameter }

You can declare a parameter of type `Response` in your *path operation function* (as you can do for cookies and headers).

And then you can set the `status_code` in that *temporal* response object.

{* ../../docs_src/response_change_status_code/tutorial001_py310.py hl[1,9,12] *}

And then you can return any object you need, as you normally would (a `dict`, a database model, etc).

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Thu Mar 05 18:13:19 GMT 2026

- 1.5K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs_src/security/tutorial007_py310.py

    is_correct_password = secrets.compare_digest(
        current_password_bytes, correct_password_bytes
    )
    if not (is_correct_username and is_correct_password):
        raise HTTPException(
            status_code=status.HTTP_401_UNAUTHORIZED,
            detail="Incorrect username or password",
            headers={"WWW-Authenticate": "Basic"},
        )
    return credentials.username


@app.get("/users/me")

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Thu Feb 12 13:19:43 GMT 2026

- 1.1K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs_src/security/tutorial007_an_py310.py

    is_correct_password = secrets.compare_digest(
        current_password_bytes, correct_password_bytes
    )
    if not (is_correct_username and is_correct_password):
        raise HTTPException(
            status_code=status.HTTP_401_UNAUTHORIZED,
            detail="Incorrect username or password",
            headers={"WWW-Authenticate": "Basic"},
        )
    return credentials.username


@app.get("/users/me")

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Thu Feb 12 13:19:43 GMT 2026

- 1.1K bytes

- Click Count (0)

github.com/tiangolo/fastapi

tests/test_dependency_yield_scope.py


def test_function_scope() -> None:
    response = client.get("/function-scope")
    assert response.status_code == 200
    data = response.json()
    assert data["is_open"] is False


def test_request_scope() -> None:
    response = client.get("/request-scope")
    assert response.status_code == 200
    data = response.json()
    assert data["is_open"] is True


def test_two_scopes() -> None:

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Wed Dec 17 21:25:59 GMT 2025

- 6.7K bytes

- Click Count (0)

github.com/tiangolo/fastapi

docs/zh-hant/docs/advanced/additional-status-codes.md

如果你想在主要狀態碼之外再回傳其他狀態碼，可以直接回傳一個 `Response`（例如 `JSONResponse`），並直接設定你想要的額外狀態碼。

例如，你想要有一個允許更新項目的路徑操作，成功時回傳 HTTP 狀態碼 200 "OK"。

但你也希望它能接受新項目；當項目先前不存在時就建立它們，並回傳 HTTP 狀態碼 201 "Created"。

要達成這點，匯入 `JSONResponse`，直接在那裡回傳內容，並設定你想要的 `status_code`：

{* ../../docs_src/additional_status_codes/tutorial001_an_py310.py hl[4,25] *}

/// warning

當你直接回傳一個 `Response`（就像上面的範例），它會原封不動地被送出。

不會再經過模型序列化等處理。

請確認其中包含你要的資料，且各值是合法的 JSON（如果你使用的是 `JSONResponse`）。

Created: Sun Apr 05 07:19:11 GMT 2026

- Last Modified: Fri Mar 20 17:05:38 GMT 2026

- 1.8K bytes

- Click Count (0)

Search Options