MyApp

QueryAlbums

Media

The following routes are available for this service:
GET	/albums
GET	/albums/{AlbumId}

const std = @import("std");

pub const Albums = struct {
    albumId: i64 = 0,
    // @Required()
    title: ?[]const u8 = null,

    artistId: i64 = 0,
};

pub const QueryAlbums = struct {
    // @DataMember(Order=1)
    skip: ?i32 = null,

    // @DataMember(Order=2)
    take: ?i32 = null,

    // @DataMember(Order=3)
    orderBy: ?[]const u8 = null,

    // @DataMember(Order=4)
    orderByDesc: ?[]const u8 = null,

    // @DataMember(Order=5)
    include: ?[]const u8 = null,

    // @DataMember(Order=6)
    fields: ?[]const u8 = null,

    // @DataMember(Order=7)
    meta: ?std.json.Value = null,
    albumId: ?i64 = null,
};

pub const Todo = struct {
    id: i64 = 0,
    text: ?[]const u8 = null,
    isFinished: bool = false,
};

Zig QueryAlbums DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /albums HTTP/1.1 
Host: blazor-gallery.servicestack.net 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	offset: 0,
	total: 0,
	results: 
	[
		{
			albumId: 0,
			title: String,
			artistId: 0
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}