fastapi Architecture Docs
Home / File/ test_security_oauth2_authorization_code_bearer_scopes_openapi_simple.py — fastapi Source File

test_security_oauth2_authorization_code_bearer_scopes_openapi_simple.py — fastapi Source File

Architecture documentation for test_security_oauth2_authorization_code_bearer_scopes_openapi_simple.py, a python file in the fastapi codebase. 5 imports, 0 dependents.

File python FastAPI Responses 5 imports 4 functions

Entity Profile

Dependency Diagram

graph LR
  9ca94544_ed54_7e6f_1d88_3eb03ea7319d["test_security_oauth2_authorization_code_bearer_scopes_openapi_simple.py"]
  0dda2280_3359_8460_301c_e98c77e78185["typing"]
  9ca94544_ed54_7e6f_1d88_3eb03ea7319d --> 0dda2280_3359_8460_301c_e98c77e78185
  534f6e44_61b8_3c38_8b89_6934a6df9802["__init__.py"]
  9ca94544_ed54_7e6f_1d88_3eb03ea7319d --> 534f6e44_61b8_3c38_8b89_6934a6df9802
  35c4ea20_c454_5afd_6cda_f0818bbcc650["__init__.py"]
  9ca94544_ed54_7e6f_1d88_3eb03ea7319d --> 35c4ea20_c454_5afd_6cda_f0818bbcc650
  a7c04dee_ee23_5891_b185_47ff6bed036d["testclient.py"]
  9ca94544_ed54_7e6f_1d88_3eb03ea7319d --> a7c04dee_ee23_5891_b185_47ff6bed036d
  a7f4e7b0_9725_db90_5cbc_7ca8211b323a["inline_snapshot"]
  9ca94544_ed54_7e6f_1d88_3eb03ea7319d --> a7f4e7b0_9725_db90_5cbc_7ca8211b323a
  style 9ca94544_ed54_7e6f_1d88_3eb03ea7319d fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

# Ref: https://github.com/fastapi/fastapi/issues/14454

from typing import Annotated

from fastapi import Depends, FastAPI, Security
from fastapi.security import OAuth2AuthorizationCodeBearer
from fastapi.testclient import TestClient
from inline_snapshot import snapshot

oauth2_scheme = OAuth2AuthorizationCodeBearer(
    authorizationUrl="api/oauth/authorize",
    tokenUrl="/api/oauth/token",
    scopes={"read": "Read access", "write": "Write access"},
)


async def get_token(token: Annotated[str, Depends(oauth2_scheme)]) -> str:
    return token


app = FastAPI(dependencies=[Depends(get_token)])


@app.get("/admin", dependencies=[Security(get_token, scopes=["read", "write"])])
async def read_admin():
    return {"message": "Admin Access"}


client = TestClient(app)


def test_read_admin():
    response = client.get("/admin", headers={"Authorization": "Bearer faketoken"})
    assert response.status_code == 200, response.text
    assert response.json() == {"message": "Admin Access"}


def test_openapi_schema():
    response = client.get("/openapi.json")
    assert response.status_code == 200, response.text
    assert response.json() == snapshot(
        {
            "openapi": "3.1.0",
            "info": {"title": "FastAPI", "version": "0.1.0"},
            "paths": {
                "/admin": {
                    "get": {
                        "summary": "Read Admin",
                        "operationId": "read_admin_admin_get",
                        "responses": {
                            "200": {
                                "description": "Successful Response",
                                "content": {"application/json": {"schema": {}}},
                            }
                        },
                        "security": [
                            {"OAuth2AuthorizationCodeBearer": ["read", "write"]}
                        ],
                    }
                }
            },
            "components": {
                "securitySchemes": {
                    "OAuth2AuthorizationCodeBearer": {
                        "type": "oauth2",
                        "flows": {
                            "authorizationCode": {
                                "scopes": {
                                    "read": "Read access",
                                    "write": "Write access",
                                },
                                "authorizationUrl": "api/oauth/authorize",
                                "tokenUrl": "/api/oauth/token",
                            }
                        },
                    }
                }
            },
        }
    )

Domain

Subdomains

Functions

Dependencies

Source

Frequently Asked Questions

What does test_security_oauth2_authorization_code_bearer_scopes_openapi_simple.py do?
test_security_oauth2_authorization_code_bearer_scopes_openapi_simple.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 test_security_oauth2_authorization_code_bearer_scopes_openapi_simple.py?
test_security_oauth2_authorization_code_bearer_scopes_openapi_simple.py defines 4 function(s): get_token, read_admin, test_openapi_schema, test_read_admin.
What does test_security_oauth2_authorization_code_bearer_scopes_openapi_simple.py depend on?
test_security_oauth2_authorization_code_bearer_scopes_openapi_simple.py imports 5 module(s): __init__.py, __init__.py, inline_snapshot, testclient.py, typing.
Where is test_security_oauth2_authorization_code_bearer_scopes_openapi_simple.py in the architecture?
test_security_oauth2_authorization_code_bearer_scopes_openapi_simple.py is located at tests/test_security_oauth2_authorization_code_bearer_scopes_openapi_simple.py (domain: FastAPI, subdomain: Responses, directory: tests).

Analyze Your Own Codebase

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

Try Supermodel Free