OpenAPI

Immich nutzt den OpenAPI-Standard, um API-Dokumentationen zu erstellen. Um die veröffentlichten Dokumentationen anzusehen, klicken Sie hier.

Generator

OpenAPI wird zur Generierung des Client-SDKs (Typescript, Dart) verwendet. openapi-generator-cli kann hier installiert werden. Das generierte SDK basiert auf der Datei immich-openapi-specs.json, die im Entwicklungsmodus automatisch vom Server erstellt wird. Diese Datei kann mit @nestjs/swagger-Dekoratoren geändert werden, die von Controller-Endpunkten verwendet oder referenziert werden. Weitere Informationen finden Sie in den NestJS OpenAPI-Dokumenten. Wenn Sie einen neuen Endpunkt hinzufügen oder einen bestehenden ändern, müssen Sie den Server im Entwicklungsmodus starten und den unten stehenden Befehl ausführen, um das Client-SDK zu aktualisieren.

make open-api

Das generierte Client-SDK finden Sie für das Typescript-SDK unter open-api/typescript-sdk/client und für das Dart-SDK unter mobile/openapi.