GET | /todos |
---|
import Foundation
import ServiceStack
public class QueryTodos : QueryData<Todo>
{
public var id:Int?
public var ids:[Int]
public var textContains:String
// @DataMember(Order=1)
public var skip:Int?
// @DataMember(Order=2)
public var take:Int?
// @DataMember(Order=3)
public var orderBy:String
// @DataMember(Order=4)
public var orderByDesc:String
// @DataMember(Order=5)
public var include:String
// @DataMember(Order=6)
public var fields:String
// @DataMember(Order=7)
public var meta:[String:String]
required public init(){ super.init() }
private enum CodingKeys : String, CodingKey {
case id
case ids
case textContains
case skip
case take
case orderBy
case orderByDesc
case include
case fields
case meta
}
required public init(from decoder: Decoder) throws {
try super.init(from: decoder)
let container = try decoder.container(keyedBy: CodingKeys.self)
id = try container.decodeIfPresent(Int.self, forKey: .id)
ids = try container.decodeIfPresent([Int].self, forKey: .ids) ?? []
textContains = try container.decodeIfPresent(String.self, forKey: .textContains)
skip = try container.decodeIfPresent(Int.self, forKey: .skip)
take = try container.decodeIfPresent(Int.self, forKey: .take)
orderBy = try container.decodeIfPresent(String.self, forKey: .orderBy)
orderByDesc = try container.decodeIfPresent(String.self, forKey: .orderByDesc)
include = try container.decodeIfPresent(String.self, forKey: .include)
fields = try container.decodeIfPresent(String.self, forKey: .fields)
meta = try container.decodeIfPresent([String:String].self, forKey: .meta) ?? [:]
}
public override func encode(to encoder: Encoder) throws {
try super.encode(to: encoder)
var container = encoder.container(keyedBy: CodingKeys.self)
if id != nil { try container.encode(id, forKey: .id) }
if ids.count > 0 { try container.encode(ids, forKey: .ids) }
if textContains != nil { try container.encode(textContains, forKey: .textContains) }
if skip != nil { try container.encode(skip, forKey: .skip) }
if take != nil { try container.encode(take, forKey: .take) }
if orderBy != nil { try container.encode(orderBy, forKey: .orderBy) }
if orderByDesc != nil { try container.encode(orderByDesc, forKey: .orderByDesc) }
if include != nil { try container.encode(include, forKey: .include) }
if fields != nil { try container.encode(fields, forKey: .fields) }
if meta.count > 0 { try container.encode(meta, forKey: .meta) }
}
}
public class Todo : Codable
{
public var id:Int
public var text:String
public var isFinished:Bool
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /todos HTTP/1.1 Host: vue-vite-api.jamstacks.net Accept: text/jsv
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { offset: 0, total: 0, results: [ { id: 0, text: String, isFinished: False } ], meta: { String: String }, responseStatus: { errorCode: String, message: String, stackTrace: String, errors: [ { errorCode: String, fieldName: String, message: String, meta: { String: String } } ], meta: { String: String } } }