OpenAPI

Immich utilise la norme OpenAPI pour générer la documentation de l'API. Pour consulter la documentation publiée, cliquez ici.

Générateur

OpenAPI est utilisé pour générer les SDK client (Typescript, Dart). openapi-generator-cli peut être installé ici. Le SDK généré est basé sur le fichier immich-openapi-specs.json, qui est auto-généré par le serveur lorsqu'il est exécuté en mode développement. Le fichier immich-openapi-specs.json peut être modifié à l'aide des décorateurs @nestjs/swagger utilisés ou référencés par les points de terminaison du contrôleur. Consultez les docs OpenAPI de NestJS pour plus d'informations. Lorsque vous ajoutez un nouveau point de terminaison ou modifiez un existant, vous devez exécuter le serveur en mode développement et exécuter la commande ci-dessous pour mettre à jour le SDK client.

make open-api

Vous trouverez le SDK client généré dans open-api/typescript-sdk/client pour le SDK Typescript et dans mobile/openapi pour le SDK Dart.