Sdílet prostřednictvím

Vytvoření vývojového prostředí GitHub Codespaces s využitím FastAPI a Postgres

V tomto článku se dozvíte, jak spustit FastAPI a Postgres společně v prostředí GitHub Codespaces . Codespaces je vývojové prostředí hostované v cloudu, které umožňuje vytvářet konfigurovatelná a opakovatelná vývojová prostředí.

Ukázkové úložiště můžete otevřít v prohlížeči nebo v integrovaném vývojovém prostředí (IDE), jako je Visual Studio Code , s rozšířením GitHub Codespaces.

Případně můžete ukázkové úložiště naklonovat místně. Když projekt otevřete v editoru Visual Studio Code, můžete ho spustit pomocí Dev Containers. Dev Containers vyžaduje, aby se Desktop Dockeru nainstaloval místně. Pokud docker není nainstalovaný, můžete projekt spustit pomocí GitHub Codespaces jako vývojového prostředí.

Při použití GitHub Codespaces mějte na paměti, že máte pevný počet hodin jádra zdarma za měsíc. Tento kurz k dokončení vyžaduje méně než jednu jádrovou hodinu. Další informace najdete v tématu Informace o fakturaci pro GitHub Codespaces.

Toto nastavení můžete použít také jako výchozí bod a upravit ukázku tak, aby spouštěla další webové architektury Pythonu, jako je Django nebo Flask.

Spuštění vývojového prostředí v Codespaces

Tento kurz představuje jeden z mnoha možných způsobů vytváření a práce s Codespaces GitHubu.

  1. Přejděte do ukázkového úložiště https://github.com/Azure-Samples/msdocs-fastapi-postgres-codespaceaplikace.

    Ukázkové úložiště má veškerou konfiguraci potřebnou k vytvoření prostředí s aplikací FastAPI pomocí databáze Postgres. Podobný projekt můžete vytvořit podle kroků v části Nastavení projektu Pythonu pro GitHub Codespaces.

  2. Vyberte kód, kartu Codespaces a + vytvořte nový prostor kódu.

    Snímek obrazovky znázorňující, jak vytvořit prostor kódu z úložiště GitHub

  3. Po dokončení sestavování kontejneru ověřte, že se v levém dolním rohu prohlížeče zobrazí Codespaces a uvidíte ukázkové úložiště.

    Konfigurační soubory klíče codespace jsou devcontainer.json, Dockerfile a docker-compose.yml. Další informace viz GitHub Codespaces – přehled.

    Návod

    V editoru Visual Studio Code můžete také spustit codespace. Vyberte Codespaces v levém dolním rohu prohlížeče nebo (Ctrl + Shift + P / Ctrl + Command + P) a zadejte Codespaces. Pak vyberte Otevřít v editoru VS Code. Pokud také zastavíte codespace a vrátíte se do úložiště a znovu ho otevřete v GitHub Codespaces, máte možnost ho otevřít ve VS Code nebo prohlížeči.

  4. Vyberte soubor .env.devcontainer a vytvořte kopii s názvem .env se stejným obsahem.

    .env obsahuje proměnné prostředí, které se používají v kódu pro připojení k databázi.

  5. Pokud okno terminálu ještě není otevřené, otevřete ho tak, že otevřete paletu příkazů (Ctrl + Shift + P / Ctrl + Command + P), zadáte "Terminal: Create New Terminal" (Terminál: Create New Terminal) a vyberete ho, aby se vytvořil nový terminál.

  6. V okně terminálu vyberte kartu PORTY a ověřte, že postgreSQL běží na portu 5432.

  7. V okně terminálu spusťte aplikaci FastAPI.

    uvicorn main:app --reload

  8. Vyberte oznámení Otevřít v prohlížeči.

    Pokud oznámení nevidíte nebo nezmeškali, přejděte na PORTY a vyhledejte místní adresu portu 8000. Použijte tam uvedenou adresu URL.

  9. Na konec adresy URL verze Preview přidejte /docs , abyste viděli uživatelské rozhraní Swagger, které umožňuje otestovat metody rozhraní API.

    Metody rozhraní API se generují z rozhraní OpenAPI, které FastAPI vytvoří z kódu.

    Snímek obrazovky s uživatelským rozhraním FastAPI Swagger

  10. Na stránce Swagger spusťte metodu POST a přidejte restauraci.

    1. Rozbalte metodu POST .

    2. Vyberte Vyzkoušet.

    3. Vyplňte text požadavku.

      {
  "name": "Restaurant 1",
  "address": "Restaurant 1 address"
}

    4. Výběrem Provést potvrďte změnu.

Připojení k databázi a zobrazení dat

  1. Vraťte se do GitHub Codespace projektu, vyberte rozšíření SQLTools a pak vyberte Místní databáze , ke které se chcete připojit.

    Rozšíření SQLTools by se mělo nainstalovat při vytvoření kontejneru. Pokud se rozšíření SQLTools nezobrazí na panelu aktivit, zavřete prostor kódu a znovu ho otevřete.

  2. Rozbalte uzel Místní databáze , dokud nenajdete tabulku restaurací , vyberte možnost Zobrazit záznamy tabulky.

    Měla by se zobrazit restaurace, kterou jste přidali.

    Snímek obrazovky znázorňující postup použití rozšíření SQLTools v editoru Visual Studio Code pro připojení k místní databázi Postgres a zobrazení záznamů tabulek

Vyčištění

Pokud chcete funkci codespace přestat používat, zavřete prohlížeč. (Pokud jste ho otevřeli tímto způsobem, zavřete VS Code.)

Pokud máte v plánu znovu používat codespace, můžete ho zachovat. Poplatky za procesor jsou účtovány pouze pro aktivní kódovací prostory. Zastavený prostor kódu způsobuje pouze náklady na úložiště.

Pokud chcete odebrat prostor kódu, přejděte ke https://github.com/codespaces správě prostorů kódu.

Další kroky