https://kotlinlang.org logo
Channels
Powered by
#http4k
  • x

    xuemin.guan

    01/30/2019, 4:32 PM
    hi all, I have a question about using Typesafe contracts to generate Swagger documentation to describe the format of a json body to be received by a post.
  • x

    xuemin.guan

    01/30/2019, 4:33 PM
    I don’t find a way of doing it. Can anyone show an example? It this supported?
  • d

    dave

    01/30/2019, 4:48 PM
    @xuemin.guan yep - use receiving() in the meta for the route
  • d

    dave

    01/30/2019, 4:52 PM
    you can then pass a lens with an example, using this overloaded version:
    Copy code
    fun <T> receiving(bodyToDefinitionId: Pair<BiDiBodyLens<T>, T>, definitionId: String? = null)
  • x

    xuemin.guan

    01/30/2019, 4:56 PM
    my_code_.txt
    my_code_.txt
  • x

    xuemin.guan

    01/30/2019, 4:56 PM
    How do I describe json body?
  • d

    dave

    01/30/2019, 4:56 PM
    are you using auto marshalling?
  • d

    dave

    01/30/2019, 4:57 PM
    (ie auto-conversion to data classes from the JSON)?
  • x

    xuemin.guan

    01/30/2019, 4:57 PM
    yes, I am
  • d

    dave

    01/30/2019, 4:57 PM
    jackson moshi or gson?
  • x

    xuemin.guan

    01/30/2019, 4:57 PM
    jackson
  • x

    xuemin.guan

    01/30/2019, 5:00 PM
    A_modified_version_of_my_production_code_to_hide_sensitive_information.txt
    A_modified_version_of_my_production_code_to_hide_sensitive_information.txt
  • x

    xuemin.guan

    01/30/2019, 5:00 PM
    I thought I could describe what the json body should be and it will appear in the swagger doc
  • d

    dave

    01/30/2019, 5:00 PM
    you can.
  • d

    dave

    01/30/2019, 5:00 PM
    let me work out an example quickly
  • x

    xuemin.guan

    01/30/2019, 5:07 PM
    cheers @dave
  • d

    dave

    01/30/2019, 5:15 PM
    @xuemin.guan try this:
  • d

    dave

    01/30/2019, 5:15 PM
    Copy code
    package guide.modules.contracts

import org.http4k.contract.ApiInfo
import org.http4k.contract.OpenApi
import org.http4k.contract.contract
import org.http4k.contract.meta
import org.http4k.core.Body
import org.http4k.core.HttpHandler
import org.http4k.core.Method.GET
import <http://org.http4k.core.Method.POST|org.http4k.core.Method.POST>
import org.http4k.core.Request
import org.http4k.core.Response
import org.http4k.core.Status.Companion.OK
import org.http4k.core.with
import org.http4k.format.Jackson
import org.http4k.format.Jackson.auto

data class MyGreatThing(val value: String)

fun main() {

    val bodyLens = Body.auto<MyGreatThing>().toLens()

    val handler: HttpHandler =
        contract(OpenApi(ApiInfo("awesome", "1.0"), Jackson),
            "/echo" meta {
                summary = "my echo endpoint"
                receiving(bodyLens to MyGreatThing("foobar"))
                returning("cool" to Response(OK).with(bodyLens of MyGreatThing("foobar")))
            }
                bindContract POST to { Response(OK).with(bodyLens of bodyLens(it)) })

    println(handler(Request(GET, "/")))
}
  • d

    dave

    01/30/2019, 5:16 PM
    the most important line there is this:
    Copy code
    import org.http4k.format.Jackson.auto
  • x

    xuemin.guan

    01/30/2019, 5:16 PM
    ah, I see, that is how you do it!
  • d

    dave

    01/30/2019, 5:16 PM
    because that will NOT get imported automatically (since it's an extension method that is defined on the Jackson class)
  • x

    xuemin.guan

    01/30/2019, 5:16 PM
    thank you David!
  • x

    xuemin.guan

    01/30/2019, 5:17 PM
    BTW, http4k is well liked here! Awesome library! It has very positively affected my experience with kotlin.
    🙂 1
  • x

    xuemin.guan

    01/30/2019, 5:31 PM
    Not_sure_it_worked_.js
    Not_sure_it_worked_.js
  • x

    xuemin.guan

    01/30/2019, 5:32 PM
    hi @dave not sure your example worked.
  • x

    xuemin.guan

    01/30/2019, 5:32 PM
    ah, I see.
  • x

    xuemin.guan

    01/30/2019, 5:32 PM
    it creates a ref
  • x

    xuemin.guan

    01/30/2019, 5:32 PM
    sorry, I missed that.
  • x

    xuemin.guan

    01/30/2019, 5:32 PM
    yup, it worked.
    😊 1
    🤦‍♂️ 2
  • x

    Xavier Hanin

    01/31/2019, 8:35 AM
    Hi, is it possible to apply Jackson views when using the Jackson 
    Body.auto
    lenses?
1...656667...91Latest