Korest Docs is a Kotlin library that extends Spring REST Docs. It makes creating API documentation easy using Kotlin DSL. You can generate API documentation using a test framework (e.g., MockMvc, RestAssured, WebTestClient) or simply by declaring it.

How to use

build.gradle.kts

val version = "x.x.x"
dependencies {
    implementation("io.github.lcomment:korest-docs-starter:$version")
}

Test Code

. . .
@ExtendWith(KorestDocumentationExtension::class)
internal class ApiSpec {
    . . .
}

Requirements

• Kotlin 1.9 or higher
• Spring Boot 3.0.0 or higher

Contributing

Contributors to this project agree to uphold its code of conduct.

There are several that you can contribute to Korest Docs:

• Open a pull request. Please see the contributor guidelines for details