IkigaJSON Documentation

To use IkigaJSON in Vapor 4, extend IkigaJSONEncoder to conform to ContentEncoder and IkigaJSONDecoder to conform to ContentDecoder. You must then register them with ContentConfiguration.global.

extension IkigaJSONEncoder: ContentEncoder {
    public func encode<E: Encodable>(
        _ encodable: E,
        to body: inout ByteBuffer,
        headers: inout HTTPHeaders
    ) throws {
        headers.contentType = .json
        try self.encodeAndWrite(encodable, into: &body)
    }

    public func encode<E>(_ encodable: E, to body: inout ByteBuffer, headers: inout HTTPHeaders, userInfo: [CodingUserInfoKey : Sendable]) throws where E : Encodable {
        var encoder = self
        encoder.userInfo = userInfo
        headers.contentType = .json
        try encoder.encodeAndWrite(encodable, into: &body)
    }

    public func encode<E>(_ encodable: E, to body: inout ByteBuffer, headers: inout HTTPHeaders, userInfo: [CodingUserInfoKey : Any]) throws where E : Encodable {
        var encoder = self
        encoder.userInfo = userInfo
        headers.contentType = .json
        try encoder.encodeAndWrite(encodable, into: &body)
    }
}

extension IkigaJSONDecoder: ContentDecoder {
    public func decode<D: Decodable>(
        _ decodable: D.Type,
        from body: ByteBuffer,
        headers: HTTPHeaders
    ) throws -> D {
        return try self.decode(D.self, from: body)
    }
    
    public func decode<D>(_ decodable: D.Type, from body: ByteBuffer, headers: HTTPHeaders, userInfo: [CodingUserInfoKey : Sendable]) throws -> D where D : Decodable {
        let decoder = IkigaJSONDecoder(settings: settings)
        decoder.settings.userInfo = userInfo
        return try decoder.decode(D.self, from: body)
    }

    public func decode<D>(_ decodable: D.Type, from body: ByteBuffer, headers: HTTPHeaders, userInfo: [CodingUserInfoKey : Any]) throws -> D where D : Decodable {
        let decoder = IkigaJSONDecoder(settings: settings)
        decoder.settings.userInfo = userInfo
        return try decoder.decode(D.self, from: body)
    }
}

// Registration
var decoder = IkigaJSONDecoder()
decoder.settings.dateDecodingStrategy = .iso8601
ContentConfiguration.global.use(decoder: decoder, for: .json)

var encoder = IkigaJSONEncoder()
encoder.settings.dateEncodingStrategy = .iso8601
ContentConfiguration.global.use(encoder: encoder, for: .json)

To use IkigaJSON in Hummingbird 2, extend IkigaJSONEncoder to conform to ResponseEncoder and IkigaJSONDecoder to conform to RequestDecoder.

extension IkigaJSONEncoder: ResponseEncoder {
    public func encode(_ value: some Encodable, from request: Request, context: some BaseRequestContext) throws -> Response {
        // Capacity should roughly cover the amount of data you regularly expect to encode
        // However, the buffer will grow if needed
        var buffer = context.allocator.buffer(capacity: 2048)
        try self.encodeAndWrite(value, into: &buffer)
        return Response(
            status: .ok, 
            headers: [
                .contentType: "application/json; charset=utf-8",
            ], 
            body: .init(byteBuffer: buffer)
        )
    }
}

extension IkigaJSONDecoder: RequestDecoder {
    public func decode<T>(_ type: T.Type, from request: Request, context: some BaseRequestContext) async throws -> T where T : Decodable {
        let data = try await request.body.collate(maxSize: context.maxUploadSize)
        return try self.decode(T.self, from: data)
    }
}