https://kotlinlang.org logo
Channels
100daysofcode
100daysofkotlin
100daysofkotlin-2021
advent-of-code
aem
ai
alexa
algeria
algolialibraries
amsterdam
android
android-architecture
android-databinding
android-studio
androidgithubprojects
androidthings
androidx
androidx-xprocessing
anime
anko
announcements
apollo-kotlin
appintro
arabic
argentina
arkenv
arksemdevteam
armenia
arrow
arrow-contributors
arrow-meta
ass
atlanta
atm17
atrium
austin
australia
austria
awesome-kotlin
ballast
bangladesh
barcelona
bayarea
bazel
beepiz-libraries
belgium
benchmarks
berlin
big-data
books
boston
brazil
brikk
budapest
build
build-tools
bulgaria
bydgoszcz
cambodia
canada
carrat
carrat-dev
carrat-feed
chicago
chile
china
chucker
cincinnati-user-group
cli
clikt
cloudfoundry
cn
cobalt
code-coverage
codeforces
codemash-precompiler
codereview
codingame
codingconventions
coimbatore
collaborations
colombia
colorado
communities
competitive-programming
competitivecoding
compiler
compose
compose-android
compose-desktop
compose-hiring
compose-ios
compose-mp
compose-ui-showcase
compose-wear
compose-web
confetti
connect-audit-events
corda
cork
coroutines
couchbase
coursera
croatia
cryptography
cscenter-course-2016
cucumber-bdd
cyprus
czech
dagger
data2viz
databinding
datascience
dckotlin
debugging
decompose
decouple
denmark
deprecated
detekt
detekt-hint
dev-core
dfw
docs-revamped
dokka
domain-driven-design
doodle
dsl
dublin
dutch
eap
eclipse
ecuador
edinburgh
education
effective-kotlin
effectivekotlin
emacs
embedded-kotlin
estatik
event21-community-content
events
exposed
failgood
fb-internal-demo
feed
firebase
flow
fluid-libraries
forkhandles
forum
fosdem
fp-in-kotlin
framework-elide
freenode
french
fritz2
fuchsia
functional
funktionale
gamedev
ge-kotlin
general-advice
georgia
geospatial
german-lang
getting-started
github-workflows-kt
glance
godot-kotlin
google-io
gradle
graphic
graphkool
graphql
graphql-kotlin
graviton-browser
greece
grpc
gsoc
gui
hackathons
hacktoberfest
hamburg
hamkrest
helios
helsinki
hexagon
hibernate
hikari-cp
hire-me
hiring
hongkong
hoplite
http4k
hungary
hyderabad
image-processing
india
indonesia
inkremental
intellij
intellij-plugins
intellij-tricks
internships
introduce-yourself
io
ios
iran
israel
istanbulcoders
italian
jackson-kotlin
jadx
japanese
jasync-sql
java-to-kotlin-refactoring
javadevelopers
javafx
javalin
javascript
jdbi
jhipster-kotlin
jobsworldwide
jpa
jshdq
juul-libraries
jvm-ir-backend-feedback
jxadapter
k2-early-adopters
kaal
kafka
kakao
kalasim
kapt
karachi
karg
karlsruhe
kash_shell
kaskade
kbuild
kdbc
kgen-doc-tools
kgraphql
kinta
klaxon
klock
kloudformation
kmdc
kmm-español
kmongo
knbt
knote
koalaql
koans
kobalt
kobweb
kodein
kodex
kohesive
koin
koin-dev
komapper
kondor-json
kong
kontent
kontributors
korau
korean
korge
korim
korio
korlibs
korte
kotest
kotest-contributors
kotless
kotlick
kotlin-asia
kotlin-beam
kotlin-by-example
kotlin-csv
kotlin-data-storage
kotlin-foundation
kotlin-fuel
kotlin-in-action
kotlin-inject
kotlin-latam
kotlin-logging
kotlin-multiplatform-contest
kotlin-mumbai
kotlin-native
kotlin-pakistan
kotlin-plugin
kotlin-pune
kotlin-roadmap
kotlin-samples
kotlin-sap
kotlin-serbia
kotlin-spark
kotlin-szeged
kotlin-website
kotlinacademy
kotlinbot
kotlinconf
kotlindl
kotlinforbeginners
kotlingforbeginners
kotlinlondon
kotlinmad
kotlinprogrammers
kotlinsu
kotlintest
kotlintest-devs
kotlintlv
kotlinultimatechallenge
kotlinx-datetime
kotlinx-files
kotlinx-html
kotrix
kotson
kovenant
kprompt
kraph
krawler
kroto-plus
ksp
ktcc
ktfmt
ktlint
ktor
ktp
kubed
kug-leads
kug-torino
kvision
kweb
lambdaworld_cadiz
lanark
language-evolution
language-proposals
latvia
leakcanary
leedskotlinusergroup
lets-have-fun
libgdx
libkgd
library-development
lincheck
linkeddata
lithuania
london
losangeles
lottie
love
lychee
macedonia
machinelearningbawas
madrid
malaysia
mathematics
meetkotlin
memes
meta
metro-detroit
mexico
miami
micronaut
minnesota
minutest
mirror
mockk
moko
moldova
monsterpuzzle
montreal
moonbean
morocco
motionlayout
mpapt
mu
multiplatform
mumbai
munich
mvikotlin
mvrx
myndocs-oauth2-server
naming
navigation-architecture-component
nepal
new-mexico
new-zealand
newname
nigeria
nodejs
norway
npm-publish
nyc
oceania
ohio-kotlin-users
oldenburg
oolong
opensource
orbit-mvi
osgi
otpisani
package-search
pakistan
panamá
pattern-matching
pbandk
pdx
peru
philippines
phoenix
pinoy
pocketgitclient
polish
popkorn
portugal
practical-functional-programming
proguard
prozis-android-backup
pyhsikal
python
python-contributors
quasar
random
re
react
reaktive
realm
realworldkotlin
reductor
reduks
redux
redux-kotlin
refactoring-to-kotlin
reflect
refreshversions
reports
result
rethink
revolver
rhein-main
rocksdb
romania
room
rpi-pico
rsocket
russian
russian_feed
russian-kotlinasfirst
rx
rxjava
san-diego
science
scotland
scrcast
scrimage
script
scripting
seattle
serialization
server
sg-user-group
singapore
skia-wasm-interop-temp
skrape-it
slovak
snake
sofl-user-group
southafrica
spacemacs
spain
spanish
speaking
spek
spin
splitties
spotify-mobius
spring
spring-security
squarelibraries
stackoverflow
stacks
stayhungrystayfoolish
stdlib
stlouis
strife-discord-lib
strikt
students
stuttgart
sudan
swagger-gradle-codegen
swarm
sweden
swing
swiss-user-group
switzerland
talking-kotlin
tallinn
tampa
teamcity
tegal
tempe
tensorflow
terminal
test
testing
testtestest
texas
tgbotapi
thailand
tornadofx
touchlab-tools
training
tricity-kotlin-user-group
trójmiasto
truth
tunisia
turkey
turkiye
twitter-feed
uae
udacityindia
uk
ukrainian
uniflow
unkonf
uruguay
utah
uuid
vancouver
vankotlin
vertx
videos
vienna
vietnam
vim
vkug
vuejs
web-mpp
webassembly
webrtc
wimix_sentry
wwdc
zircon
Powered by
Title
r

Razvan

11/04/2020, 3:13 PM
Hello, if I copy the swagger specifications generated and paste them in the swagger editor I get a lot of errors because fields description is null. Any way to set them or not generate them if null or set then to empty string ? Ex of json generate par default project
info:
  title: Test API
  version: v1.0
  description: null
tags: []
paths:
  /contract/api/v1/echo:
    post:
      summary: echoes the name and message sent to it
      description: null
      tags:
        - /contract/api/v1
      parameters: []
      requestBody:
        content:
          application/json:
            example:
              name: jim
              message: hello!
            schema:
              $ref: '#/components/schemas/NameAndMessage'
              description: null
              example: null
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              example:
                name: jim
                message: hello!
              schema:
                $ref: '#/components/schemas/NameAndMessage'
                description: null
                example: null
      security:
        - api_key: []
      operationId: postContractApiV1Echo
      deprecated: false
components:
  schemas:
    NameAndMessage:
      properties:
        name:
          example: jim
          description: null
          type: string
        message:
          example: hello!
          description: null
          type: string
      example:
        name: jim
        message: hello!
      description: null
      type: object
      required:
        - message
        - name
  securitySchemes:
    api_key:
      type: apiKey
      in: query
      name: api
openapi: 3.0.0
and the online editor https://editor.swagger.io/
d

dave

11/04/2020, 3:15 PM
You can create a custom Jackson instance which doesn't serialise nulls and the use that to create the OpenApi3Renderer
r

Razvan

11/04/2020, 3:20 PM
thanks, shouldn't be the default for OpenApiRenderer ? Otherwise any way to add description to an object or/and object fields ?
d

dave

11/04/2020, 3:21 PM
inline fun <reified T : Any> Body.Companion.auto(description: String? = null, contentNegotiation: ContentNegotiation = None) = autoBody<T>(description, contentNegotiation)
that's the Body extension method signature. ^^
r

Razvan

11/04/2020, 3:23 PM
Thanks sorry for not checking out by myself 🙂 you were right when you said "if anything should be there check sources, chances are it's there).
So that fix the comment on class but where should I look for the description of an element of a class, or that's not supported ?
d

dave

11/04/2020, 3:30 PM
you will need to add annotations to the models to get those descriptions to render:
JsonPropertyDescription
r

Razvan

11/04/2020, 3:59 PM
There's a particular setting for the lens description ? as i can't see the "It's the name and the message" in the generated json for
val nameAndMessageLens = Body.auto<NameAndMessage>(description = "It's the name and the message").toLens()
and for the fields is disconcerting
data class NameAndMessage(
        @JsonPropertyDescription("It's the name")
        val name: String,
        @JsonPropertyDescription("It's the message")
        val message: String)
I get the descriptions if I use the default Jackson as param
renderer = OpenApi3(ApiInfo("Http4KPres API", "v1.0"), Jackson)
"name": {
"example": "jim",
"description": "It's the name",
"type": "string"
}
but if i use a custom one (that's exactly the same as the Jackson object)
val customJackson = ConfigurableJackson(KotlinModule()
                .asConfigurable()
                .withStandardMappings()
                .done()
                .deactivateDefaultTyping()
                .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false)
                .configure(DeserializationFeature.FAIL_ON_IGNORED_PROPERTIES, false)
                .configure(DeserializationFeature.USE_BIG_DECIMAL_FOR_FLOATS, true)
                .configure(DeserializationFeature.USE_BIG_INTEGER_FOR_INTS, true)
        )

renderer = OpenApi3(ApiInfo("Http4KPres API", "v1.0"), customJackson)
I get a null description
"name": {
"example": "jim",
"description": null,
"type": "string"
},
d

dave

11/04/2020, 5:00 PM
that's strange..
can you look to see if JacksonFieldMetadataRetrievalStrategy gets hit in the findName method?
r

Razvan

11/04/2020, 5:15 PM
Sorry out of my league 😉 can't figure out how to do that
c

Cosmin Victor Celea

11/04/2020, 5:49 PM
Hei Razvan, I had the some problems and i just wrote my custom Jackson as David is saying
I can share the code with you
r

Razvan

11/04/2020, 5:56 PM
Thanks, happy to see that, Why that customJackson is not all right (beside it misses the
.setSerializationInclusion(JsonInclude.Include.NON_NULL)
that i commented out just to see it it was that setting that removing the description from @JsonPropertyDescription)
if that can help for testing the descriptions that does not appear : with
Jackson
get description from JsonPropertyDescription with
CustomJackson
nope. The Body.auto description does not appear for neither.
data class NameAndMessage(
        @JsonPropertyDescription("It's the name")
        val name: String,
        @JsonPropertyDescription("It's the message")
        val message: String)

val nameAndMessageLens = Body.auto<NameAndMessage>("It's the name and the message").toLens()

object ExampleContractRoute {
    private val spec = "/echo" meta {
        summary = "echoes the name and message sent to it"
        description = "This is a exemple that echoes the input string"
        receiving(nameAndMessageLens to NameAndMessage("jim", "hello!"))
        returning(Status.OK, nameAndMessageLens to NameAndMessage("jim", "hello!"))
    } bindContract <http://Method.POST|Method.POST>

    private val echo: HttpHandler = { request: Request ->
        val received: NameAndMessage = nameAndMessageLens(request)
        Response(Status.OK).with(nameAndMessageLens of received)
    }

    operator fun invoke(): ContractRoute = spec to echo
}

val app = routes(
        "/contract/api/v1" bind contract {
            // renderer = OpenApi3(ApiInfo("Http4KPres API", "v1.0"), customJackson)
            renderer = OpenApi3(ApiInfo("Test API", "v1.0"), Jackson)
            descriptionPath = "/swagger.json"
            routes += ExampleContractRoute()
        }
)

fun main() {
    DebuggingFilters.PrintRequest()
            .then(app)
            .asServer(Undertow(9000)).start()
}

object CustomJackson : ConfigurableJackson(KotlinModule()
        .asConfigurable()
        .withStandardMappings()
        .done()
        .deactivateDefaultTyping()
        .configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false)
        .configure(DeserializationFeature.FAIL_ON_IGNORED_PROPERTIES, false)
        .configure(DeserializationFeature.USE_BIG_DECIMAL_FOR_FLOATS, true)
        .configure(DeserializationFeature.USE_BIG_INTEGER_FOR_INTS, true)
        // .setSerializationInclusion(JsonInclude.Include.NON_NULL)
)