Skip to main content

Requirements

✅ Korest Docs is designed for test environments using Spring REST Docs.​

Prerequisites​

  • Kotlin 1.9 or higher
  • Spring Boot 3.0.0 or higher
  • Spring REST Docs 3.0.0 or higher

Dependencies​

DependencyDescription
korest-docs-coreKorest Docs Core library
korest-docs-mockmvcStarter dependency for fixture monkey
korest-docs-starterStarter dependency for Korest Docs

  korest-docs-starter is a starter package that comes bundled with core dependencies and plugins such as support for MockMvc by default.

Gradle​

testImplementation("io.github.lcomment:korest-docs-starter:1.0.0")

Maven​


<dependency>
    <groupId>io.github.lcomment</groupId>
    <artifactId>korest-docs-starter</artifactId>
    <version>1.0.0</version>
    <scope>test</scope>
</dependency>