OpenAPI

Immich utiliza el estándar OpenAPI para generar documentación de la API. Para ver la documentación publicada, consulta aquí.

Generador

OpenAPI se utiliza para generar el cliente (SDK de Typescript, Dart). openapi-generator-cli se puede instalar aquí. El SDK generado se basa en el archivo immich-openapi-specs.json, que es autogenerado por el servidor cuando se ejecuta en modo de desarrollo. El archivo immich-openapi-specs.json se puede modificar con los decoradores @nestjs/swagger utilizados o referenciados por los endpoints del controlador. Para más información, consulta la documentación de NestJS OpenAPI. Cuando agregues un nuevo endpoint o modifiques uno existente, debes ejecutar el servidor en modo de desarrollo y ejecutar el siguiente comando para actualizar el SDK del cliente.

make open-api

Puedes encontrar el SDK del cliente generado en open-api/typescript-sdk/client para el SDK de Typescript y en mobile/openapi para el SDK de Dart.