OpenAPI

Immich 使用 OpenAPI 標準來生成 API 文件。如需查看已發布的文件，請參見 這裡。

生成器

OpenAPI 用於生成客戶端（Typescript, Dart）SDK。openapi-generator-cli 可以在 這裡 安裝。生成的 SDK 是基於服務器 在開發模式下運行時 自動生成的 immich-openapi-specs.json 文件。可以使用 @nestjs/swagger 裝飾器修改 immich-openapi-specs.json 文件，這些裝飾器會被控制器端點引用或使用。詳情參考 NestJS OpenAPI 文檔。當您新增端點或修改現有端點時，必須在開發模式下運行服務器，並運行以下命令來更新客戶端 SDK。

make open-api

您可以在 open-api/typescript-sdk/client 中找到生成的 Typescript SDK，或在 mobile/openapi 中找到 Dart SDK。