OpenAPI

Immich 使用 OpenAPI 标准生成 API 文档。要查看已发布的文档，请参见此处。

生成器

OpenAPI 用于生成客户端（Typescript, Dart）SDK。可以在这里安装 openapi-generator-cli。生成的 SDK 基于 immich-openapi-specs.json 文件，该文件由服务器在开发模式下运行时自动生成。immich-openapi-specs.json 文件可以通过控制器端点使用或引用的 @nestjs/swagger 装饰器进行修改。有关更多信息，请参阅 NestJS OpenAPI 文档。当您添加新的端点或修改现有端点时，必须以开发模式运行服务器，并运行以下命令以更新客户端 SDK。

make open-api

您可以在 open-api/typescript-sdk/client（用于 Typescript SDK）和 mobile/openapi（用于 Dart SDK）中找到生成的客户端 SDK。