📝 Add comprehensive README documentation for core modules and scripts

[devin-ai-integration]

📝 Add comprehensive README documentation for core modules and scripts

Summary

This PR addresses undocumented parts of the FastAPI codebase by adding comprehensive README files for 5 key areas that previously lacked module-level documentation:

• fastapi/dependencies/README.md - Documents the dependency injection system, explaining models.py and utils.py with practical usage examples
• fastapi/middleware/README.md - Documents all available middleware components (CORS, GZip, HTTPS redirect, etc.) with configuration examples
• fastapi/openapi/README.md - Documents OpenAPI schema generation utilities and customization options
• fastapi/security/README.md - Documents authentication implementations including OAuth2, API keys, and HTTP auth with security best practices
• scripts/README.md - Documents development scripts including docs.py, contributors.py, translate.py and other build tools

Each README follows a consistent structure with overviews, usage examples, and links to comprehensive documentation. The goal is to improve developer experience by providing quick orientation for developers exploring the codebase.

Review & Testing Checklist for Human

• Verify code examples are accurate and functional - Test the provided code snippets to ensure they work with the current FastAPI version and follow best practices
• Check technical accuracy of module descriptions - Validate that my descriptions of what each module does align with the actual implementation
• Validate documentation links - Ensure all links to FastAPI documentation are current and point to the correct pages
• Test developer experience improvement - Try using these READMEs as a new developer would to see if they effectively explain the modules
• Verify documentation style consistency - Check that formatting, tone, and structure align with project conventions

---

Diagram

graph TD
    subgraph "FastAPI Repository"
        A[README.md]:::context
        B[fastapi/]
        C[scripts/]
        D[docs/]:::context
        
        subgraph "fastapi/ modules"
            E[fastapi/dependencies/]
            F[fastapi/middleware/]
            G[fastapi/openapi/]
            H[fastapi/security/]
            I[fastapi/dependencies/README.md]:::major-edit
            J[fastapi/middleware/README.md]:::major-edit
            K[fastapi/openapi/README.md]:::major-edit
            L[fastapi/security/README.md]:::major-edit
        end
        
        subgraph "scripts/ directory"
            M[scripts/docs.py]:::context
            N[scripts/contributors.py]:::context
            O[scripts/translate.py]:::context
            P[scripts/README.md]:::major-edit
        end
    end
    
    E --> I
    F --> J
    G --> K
    H --> L
    C --> P
    
    subgraph Legend
        L1[Major Edit - New README]:::major-edit
        L2[Minor Edit]:::minor-edit
        L3[Context/No Edit]:::context
    end

    classDef major-edit fill:#90EE90
    classDef minor-edit fill:#87CEEB
    classDef context fill:#f9f9f9

Loading

Notes

Link to Devin session: https://app.devin.ai/sessions/d3ae0fc79efb4104a2b74843da186b20

Requested by: @the-coding-gopher

This documentation effort was specifically requested to find and document undocumented parts of the FastAPI codebase. All changes are additive (new README files only) with no modifications to existing code or documentation.

The code examples provided are based on FastAPI patterns and conventions, but should be validated for accuracy since they weren't tested in a live environment during creation.

[devin-ai-integration]

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

• Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
• Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

• Disable automatic comment and CI monitoring