Freigeben über

Übersicht über die CLI für Azure Static Web Apps

  • Artikel

Wichtig

Um die Sicherheit von Bereitstellungen aus der Static Web Apps CLI zu verbessern, wurde ein Breaking Change eingeführt, der es erforderlich macht, bis zum 15. Januar 2025 ein Upgrade auf die neueste Version (2.0.2) der Static Web Apps CLI durchzuführen.

Azure Static Web Apps-Websites werden in der Cloud gehostet und umfassen häufig eine Sammlung von Clouddiensten. Während der Entwicklung und jedes Mal, wenn Sie Ihre App lokal ausführen müssen, benötigen Sie Tools, um zu simulieren, wie Ihre App in der Cloud ausgeführt wird.

Die CLI für Static Web Apps (SWA CLI) enthält eine Reihe lokaler Dienste, die simulieren, wie Ihre App in Azure ausgeführt werden würde, während sie ausschließlich auf Ihrem Computer ausgeführt wird.

Die CLI für Azure Static Web Apps bietet die folgenden Dienste:

  • Lokaler statischer Websiteserver
  • Proxy für den Entwicklungsserver des Front-End-Frameworks
  • Proxy für Ihre API-Endpunkte (verfügbar über Azure Functions Core Tools)
  • Simulierter Authentifizierungs- und Autorisierungsserver
  • Erzwingung lokaler Routen und Konfigurationseinstellungen

Funktionsweise

Das folgende Diagramm veranschaulicht die lokale Behandlung von Anforderungen:

Diagramm mit dem Anforderungs- und Antwortflow der CLI für Azure Static Web Apps.

Wichtig

Navigieren Sie zu http://localhost:4280, um auf die von der Befehlszeilenschnittstelle bereitgestellte Anwendung zuzugreifen.

  • An den Port 4280 gesendete Anforderungen werden je nach Art der Anforderung an den entsprechenden Server weitergeleitet.

  • Anforderungen vom Typ Statischer Inhalt (beispielsweise HTML oder CSS) werden entweder vom statischen Inhaltsserver der internen Befehlszeilenschnittstelle oder vom Front-End-Framework-Server (zum Debuggen) behandelt.

  • Anforderungen vom Typ Authentifizierung und Autorisierung werden von einem Emulator behandelt, der ein unechtes Identitätsprofil für Ihre App bereitstellt.

  • Von der Functions Core Tools-Runtime1 werden Anforderungen für die API der Website behandelt.

  • Antworten von allen Diensten werden an den Browser zurückgegeben, als würde es sich um eine einzelne Anwendung handeln.

Nachdem Sie die Benutzeroberfläche und die Azure Functions-API-Apps unabhängig voneinander gestartet haben, starten Sie die Static Web Apps-CLI, und verweisen Sie mit dem folgenden Befehl auf die ausgeführten Apps:

swa start http://localhost:<DEV-SERVER-PORT-NUMBER> --api-location http://localhost:7071

Wenn Sie optional den swa init-Befehl verwenden, betrachtet die Static Web Apps CLI Ihren Anwendungscode und erstellt die Konfigurationsdatei swa-cli.config.json für die CLI. Wenn Sie die Datei swa-cli.config.json verwenden, können Sie swa start ausführen, um Ihre Anwendung lokal zu starten.

1 Die Azure Functions Core Tools werden automatisch von der CLI installiert, wenn sie sich nicht bereits auf Ihrem System befinden.

Erste Schritte

Verwenden Sie die CLI für Static Web Apps mit den folgenden Ressourcen.

Resource Beschreibung
Installieren der CLI für Static Web Apps (SWA CLI) Installieren Sie die CLI für Azure Static Web Apps auf Ihrem Computer.
Konfigurieren Ihrer Umgebung Legen Sie fest, wie Ihre Anwendung Konfigurationsinformationen liest.
Starten des Website-Emulators Starten Sie den Dienst, um Ihre Website lokal zu bedienen.
Starten des lokalen API-Servers Starten Sie den Dienst, um Ihre API-Endpunkte lokal zu bedienen.
Bereitstellung in Azure Stellen Sie Ihre Anwendung in der Produktionsumgebung von Azure bereit.

Hinweis

Häufig erfordern Websites, die mit einem Front-End-Framework erstellt wurden, eine Proxykonfigurationseinstellung, um Anforderungen unter der api-Route ordnungsgemäß zu verarbeiten. Wenn Sie die Azure Static Web Apps CLI verwenden, lautet der Wert für den Proxyspeicherort /api, und ohne die CLI ist der Wert http://localhost:7071/api.

Nächste Schritte

Installieren der CLI