OpenAPI

Immich использует стандарт OpenAPI для генерации документации API. Чтобы ознакомиться с опубликованной документацией, смотрите здесь.

Генератор

OpenAPI используется для генерации клиентских SDK (Typescript, Dart). openapi-generator-cli можно установить здесь. Сгенерированный SDK основывается на файле immich-openapi-specs.json, который автоматически создается сервером при работе в режиме разработки. Файл immich-openapi-specs.json можно изменить с помощью декораторов @nestjs/swagger, используемых или связанных с конечными точками контроллера. Ознакомьтесь с документацией NestJS OpenAPI для получения дополнительной информации. Если вы добавили новую конечную точку или изменили существующую, необходимо запустить сервер в режиме разработки и выполнить команду ниже для обновления клиентского SDK.

make open-api

Вы можете найти сгенерированный клиентский SDK в open-api/typescript-sdk/client для Typescript SDK и mobile/openapi для Dart SDK.