OpenAPI

Immich는 OpenAPI 표준을 사용하여 API 문서를 생성합니다. 게시된 문서를 보려면 여기를 참조하십시오.

생성기

OpenAPI는 클라이언트 (Typescript, Dart) SDK 생성을 위해 사용됩니다. openapi-generator-cli는 여기에서 설치할 수 있습니다. 생성된 SDK는 서버가 개발 모드에서 실행 중일 때 자동 생성되는 immich-openapi-specs.json 파일을 기반으로 합니다. immich-openapi-specs.json 파일은 컨트롤러 엔드포인트에서 사용되거나 참조된 @nestjs/swagger 데코레이터를 사용하여 수정할 수 있습니다. 자세한 내용은 NestJS OpenAPI 문서를 참조하십시오. 새로운 엔드포인트를 추가하거나 기존 엔드포인트를 수정하면 개발 모드에서 서버를 실행하고 아래 명령어를 실행하여 클라이언트 SDK를 업데이트해야 합니다.

make open-api

생성된 클라이언트 SDK는 Typescript SDK의 경우 open-api/typescript-sdk/client, Dart SDK의 경우 mobile/openapi에서 찾을 수 있습니다.