Publikování rozhraní API pomocí GitHub Actions
Do webové aplikace jste přidali rozhraní API a oba běží místně. Teď je čas publikovat rozhraní API a aplikaci do Azure Static Web Apps.
Když jste vytvořili instanci Azure Static Web Apps a požádali ji o sledování hlavní větve, vygenerovala se za vás akce GitHubu. Akce GitHub naslouchá změnám ve vaší hlavní větvi úložiště a když zjistí potvrzení nebo žádost o přijetí změn pro hlavní, sestaví a publikuje vaši aplikaci.
Možná si pamatujete, že když jste vytvářeli zdroj Azure Static Web Apps, zadávali jste umístění složky pro vaše rozhraní API. Zadali jste výchozí hodnotu api. Protože jste ale v té době ve složce api neměli rozhraní API, Azure Static Web Apps se nepokoušely publikovat rozhraní API.
Teď se všechno změní.
Konfigurace akce GitHubu
Složka .github/workflows obsahuje váš soubor GitHub Action. Soubor obsahuje nastavení pro umístění webové aplikace, rozhraní API a artefaktů sestavení. Umístění, která jste zvolili při vytváření prostředku Azure Static Web Apps, se teď nacházejí v tomto souboru, jak je znázorněno tady:
app_location: 'angular-app' # App source code path
api_location: 'api' # Api source code path - optional
output_location: 'dist/angular-app' # Built app content directory - optional
app_location: 'react-app' # App source code path
api_location: 'api' # Api source code path - optional
output_location: 'build' # Built app content directory - optional
app_location: 'svelte-app' # App source code path
api_location: 'api' # Api source code path - optional
output_location: 'public' # Built app content directory - optional
app_location: 'vue-app' # App source code path
api_location: 'api' # Api source code path - optional
output_location: 'dist' # Built app content directory - optional
Vaše api_location je nastavena na správnou hodnotu, aby ukazovala na vaše API ve složce api.
Aktivace akce GitHubu
GitHub Action je připravena sestavovat a publikovat vaši webovou aplikaci a rozhraní API, jakmile detekuje změnu ve vaší hlavní větvi. Pokud chcete aktivovat GitHub Action, můžete buď provést přímý commit, nebo vytvořit pull request do hlavní větve. Změny zjištěné ve větvi hlavní aktivují akci GitHubu, aby se aplikace publikovala na stejné adrese URL vašeho živého webu.
Náhled adres URL
Někdy chcete vidět své změny v testovacím prostředí před jejich publikováním na živý web. Azure Static Web Apps umožňuje zobrazit náhled změn prostřednictvím adres URL ve verzi Preview. Náhledovou URL můžete vytvořit tím, že vytvoříte pull request proti větvi, kterou sleduje vaše GitHub akce. Na váš živý web to nemá vliv. Místo toho se vytvoří nová pracovní verze vaší aplikace. Pokud se vrátíte a zkontrolujete svůj pull request na GitHubu, měli byste vidět odkaz na přípravnou verzi umístěnou na kartě Konverzace.
Následující tabulka ukazuje, jak Azure Static Web Apps publikuje vaši aplikaci na různé adresy URL. Aplikace se publikuje na jednu adresu URL, zatímco pull request do stejné větve se publikuje na jinou adresu URL.
| Zdroj | Popis | URL |
|---|---|---|
| hlavní větev | Adresa URL živého webu | https://purple-rain-062d03304.azurestaticapps.net/ |
| Pull Request č. 5 | Náhled adresy URL | https://purple-rain-062d03304-5.azurestaticapps.net/ |
Právě pracujete ve větvi api. Vytvořte pull request z větve API do hlavní větve. Když vytvoříte pull request proti hlavní větvi, GitHub Action publikuje aplikaci na náhledovou URL.
Jakmile pracovní postup dokončí sestavování a nasazování aplikace, robot GitHubu přidá do žádosti o přijetí změn komentář, který obsahuje adresu URL předprodukčního prostředí. Výběrem tohoto odkazu můžete zobrazit připravené změny.
Dále vytvoříte pull request a navštívíte staging verzi aplikace.