OpenAPI

O Immich utiliza o padrão OpenAPI para gerar a documentação da API. Para ver a documentação publicada, veja aqui.

Gerador

O OpenAPI é usado para gerar o SDK do cliente (Typescript, Dart). O openapi-generator-cli pode ser instalado aqui. O SDK gerado é baseado no arquivo immich-openapi-specs.json, que é autogerado pelo servidor quando executado no modo de desenvolvimento. O arquivo immich-openapi-specs.json pode ser modificado com os decoradores @nestjs/swagger utilizados ou referenciados pelos endpoints dos controladores. Veja a documentação do NestJS OpenAPI para mais informações. Quando você adicionar um novo endpoint ou modificar um já existente, é necessário executar o servidor no modo de desenvolvimento e executar o comando abaixo para atualizar o SDK do cliente.

make open-api

Você pode encontrar o SDK do cliente gerado em open-api/typescript-sdk/client para o SDK de Typescript e em mobile/openapi para o SDK de Dart.