Skip to content

Add a FastAPI tutorial to our docs  #21586

Closed

Description

@luabud

Given we already have a Django and a Flask tutorial, it'd be nice to create a FastAPI one.

Activity

  1. luabud commented on Jul 17, 2023

    @luabud
    MemberAuthor

    Outline proposal:

    Prerequisites

    • Set up the project:
      • GitHub Codespaces:
        • Link to template repo
      • VS Code:
        • Create and open folder
        • Set up a virtual environment with the create environment command.
        • Create main.py application.

    Run and Debug the Project

    • Using Pydantic to define received payloads.
    • Using the automatic interactive docs at /docs to interact with the API.
    • Using Pylance’s Inlay hints.
    • Configuring the debugger.
    • Adding breakpoints.
    • Inspecting variables.
    • Running code in the debug console.

    Set up and Run Tests

    • Creating tests.
    • Setting up the test explorer.
    • Running tests from the test explorer.

    Next Steps

    Links to:

    • Devcontainers
    • Deploying to Azure
  2. minsa110 commented on Jul 18, 2023

    @minsa110

    Thanks for getting started on the outline!

    For pre-requisites, would it still make sense for us to have two paths where the other one would be to use Codespaces using a template repo (to be refined and hosted under Microsoft account)? We can link to the devcontainer from there too, since the template repo will be based on devcontainers.

    In terms of the tutorials project, are we still thinking of ChatGPT plugin--maybe towards the end? If so, we should probably add debugging tutorial for that in Codespaces as well.

  3. cwebster-99 commented on Jul 18, 2023

    @cwebster-99
    Member

    For pre-requisites, would it still make sense for us to have two paths where the other one would be to use Codespaces using a template repo (to be refined and hosted under Microsoft account)?

    +1 I would love it if we could include this, whether it is the default set-up or a path like you phrased it.

  4. luabud commented on Jul 20, 2023

    @luabud
    MemberAuthor

    love the idea! adjusted the outline to include that, thank you 😊

    about this:

    In terms of the tutorials project, are we still thinking of ChatGPT plugin--maybe towards the end? If so, we should probably add debugging tutorial for that in Codespaces as well.

    I was assuming only the setup experience would be different across Codespaces and locally, so the rest of the tutorial would be the same for both setups, including debugging. Am I missing something? 🤔

  5. luabud commented on Oct 27, 2023

    @luabud
    MemberAuthor
  6. locked as resolved and limited conversation to collaborators on Nov 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions