Ragware.QnapPhotoApi 0.8.1

QnapPhotoApi.NET

This is a .NET Web API wrapper around the QNap Photo Station api.

Provides the following capabilities.

1. An Api which calls Qnap Photo Station's /list.phtp endpoint to retrieve
   • all photos or videos (ListAsync)
   • all albums, smart or otherwise (ListAlbumsAsync)
   • all photos within an album (ListAlbumPhotosAsync)
2. Single images - This is middleware, acting as a proxy to PhotoStation on your NAS. It just forwards the response stream.
   • /image/{imageId} - Full size image
   • /thumb/{imageId} - Thumbnail of the supplied image. The size of this thumbnail depends on how thumbnails are processed in your NAS.

Configuration

1. Get the nuget package
2. Add configuration to your appsettings.json. Username and Password are the credentials you use to login to your nas.

"QnapApi": {
    "BaseUrl": "http://nas",
    "Username": "Rob",
    "Password": "Y0UrP455w0rd!"
}

3. Install in your web app/api (see below)

// This will register CSharp API client to make the /list calls.
builder.Services.AddQnapPhotoApi(builder.Configuration);

var app = builder.Build();

// This is important to get the /image and /thumb endpoints.
app.UseQnapImageMiddleware();

Usage

app.MapGet("/list/{page:int}", async (int page, [FromServices] IPhotoStationClient qnapClient, CancellationToken cancellationToken) =>
    {
        var request = new ListRequest
        {
            MediaType = MediaType.Photos,
            SortDirection = SortDirection.Descending,
            PageNumber = page,
            PageSize = 100,
        };

        return await qnapClient.ListAsync(request, cancellationToken);
    })
    .WithName("ListPhotos")
    .WithTags("QnapPhotos")
    .WithOpenApi();

app.MapGet("/list-album-photos/{albumId}/{page:int}", async (string albumId, int page, [FromServices] IPhotoStationClient qnapClient, CancellationToken cancellationToken) =>
    {
        var request = new ListAlbumPhotosRequest()
        {
            AlbumId = albumId,
            SortDirection = SortDirection.Descending,
            Sort = Sort.DateAdded,
            PageNumber = page,
            PageSize = 100,
        };

        return await qnapClient.ListAlbumPhotosAsync(request, cancellationToken);
    })
    .WithName("ListAlbumPhotos")
    .WithTags("QnapPhotos")
    .WithOpenApi();

app.MapGet("/list-album/{page:int}", async (int page, [FromServices] IPhotoStationClient qnapClient, CancellationToken cancellationToken) =>
    {
        var request = new ListAlbumsRequest()
        {
            SortDirection = SortDirection.Descending,
            AlbumType = AlbumType.All,
            Sort = AlbumSort.Title,
            PageNumber = page,
            PageSize = 100,
        };

        return await qnapClient.ListAlbumsAsync(request, cancellationToken);
    })
    .WithName("ListAlbums")
    .WithTags("QnapPhotos")
    .WithOpenApi();