跳到主要内容

运行 API

概览​

Flutter 新闻示例 API 使用 Dart 编写，并使用 Dart Frog。

在本地运行 API 服务器​

要在本地启动服务器，请从当前目录运行以下命令

dart_frog dev

这会在 localhost:8080 上启动服务器。

在 Docker 中运行 API 服务器​

要在 Docker 中运行服务器，请确保您已安装了 Docker，然后使用以下说明

  1. 使用以下命令创建生产构建
dart_frog build
  1. 将目录切换到生成的 build 目录
cd build
  1. 创建 Docker 镜像
docker build -q .

创建镜像后，使用以下命令运行它

docker run -d -p 8080:8080 --rm <IMAGE>

要终止容器

docker kill <CONTAINER>

要删除镜像

docker rmi <IMAGE>

API 文档​

在 docs/api.apib 中查找服务 API 文档。该文档使用 API Blueprint 规范。 使用 Apiary Client 预览文档。

在本地运行文档​

要在本地运行交互式 API 文档，请确保您已安装 Apiary Client

$ gem install apiaryio

然后使用 preview 命令运行文档

$ apiary preview --path docs/api.apib --watch

交互式文档可在 localhost:8080 访问。

有关详细信息，请参阅 Apiary Client 文档。

为 API 文档做贡献​

有关使用 API Blueprint 规范的文档和教程，请参阅 APIBlueprint.org。

有关详细信息，请参阅 API Blueprint 规范。

我们建议您安装 API Elements VSCode 扩展，以便在使用无效语法时提供语法高亮显示并显示错误和警告。