你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Azure Static Web Apps CLI 概述

重要

为了提高通过 Static Web Apps CLI 进行部署的安全性,我们引入了一项中断性变更,要求在 2025 年 1 月 15 日前升级到 Static Web Apps CLI 的最新版本 (2.0.2)。

Azure Static Web Apps 网站托管在云端,通常将一组云服务连接在一起。 在开发期间以及需要在本地运行应用的任何时候,都需要工具来模拟应用在云端的运行方式。

Static Web Apps CLI (SWA CLI) 提供一系列本地服务,这些服务模拟应用在 Azure 上的运行方式,但它们仅在你的计算机上运行。

Azure Static Web Apps CLI 提供以下服务:

  • 本地静态站点服务器
  • 前端框架开发服务器代理
  • API 终结点代理 - 通过 Azure Functions Core Tools 提供
  • 模拟身份验证和授权服务器
  • 强制执行本地路由和配置设置

工作原理

下图显示了在本地处理请求的方式。

显示 Azure Static Web App CLI 请求和响应流的示意图。

重要

转到 http://localhost:4280 以访问 CLI 提供服务的应用程序。

  • 通过端口 4280 的请求将根据请求的类型转发到相应的服务器。

  • 静态内容请求(如 HTML 或 CSS)由内部 CLI 静态内容服务器或前端框架服务器处理,以便进行调试。

  • 身份验证和授权请求由仿真器处理,该仿真器为应用提供虚构的身份配置文件。

  • Functions Core Tools 运行时1处理对站点 API 的请求

  • 来自所有服务的响应都返回到浏览器,就像它们都是同一个应用程序一样。

单独启动 UI 和 Azure Functions API 应用后,请启动 Static Web Apps CLI,并使用以下命令将其指向正在运行的应用:

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

(可选)如果使用 swa init 命令,Static Web Apps CLI 将查看应用程序代码并为 CLI 生成 swa-cli.config.json 配置文件。 使用 swa-cli.config.json 文件时,可以运行 swa start 以在本地启动应用程序

1 如果系统上尚未安装 Azure Functions Core Tools,则 CLI 将自动安装它们。

开始使用

通过以下资源开始使用 Static Web Apps CLI。

资源 说明
安装 Static Web Apps CLI (SWA CLI) 在计算机上安装 Azure Static Web Apps CLI。
配置环境 设置应用程序读取配置信息的方式。
启动网站模拟器 启动服务以在本地为网站提供服务。
启动本地 API 服务器 启动服务以在本地为 API 终结点提供服务。
部署到 Azure 将应用程序部署到 Azure 上的生产环境。

注意

使用前端框架构建的站点通常需要代理配置设置来正确处理 api 路由下的请求。 使用 Azure Static Web Apps CLI 时,代理位置值为 /api,不使用 CLI 时,代理位置值则为 http://localhost:7071/api

后续步骤