ResourceSnippetIntegrationTest.kt

package com.epages.restdocs.apispec

import com.epages.restdocs.apispec.ResourceDocumentation.parameterWithName
import com.epages.restdocs.apispec.ResourceDocumentation.resource
import jakarta.validation.constraints.NotEmpty
import org.hibernate.validator.constraints.Length
import org.junit.jupiter.api.extension.ExtendWith
import org.springframework.boot.SpringApplication
import org.springframework.boot.autoconfigure.SpringBootApplication
import org.springframework.boot.test.autoconfigure.restdocs.AutoConfigureRestDocs
import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest
import org.springframework.context.ConfigurableApplicationContext
import org.springframework.hateoas.EntityModel
import org.springframework.hateoas.IanaLinkRelations
import org.springframework.hateoas.Link
import org.springframework.hateoas.server.mvc.BasicLinkBuilder.linkToCurrentMapping
import org.springframework.http.HttpHeaders.ACCEPT
import org.springframework.http.HttpHeaders.CONTENT_TYPE
import org.springframework.http.ResponseEntity
import org.springframework.restdocs.headers.HeaderDocumentation.headerWithName
import org.springframework.restdocs.hypermedia.HypermediaDocumentation.linkWithRel
import org.springframework.restdocs.payload.PayloadDocumentation.fieldWithPath
import org.springframework.test.context.junit.jupiter.SpringExtension
import org.springframework.test.web.servlet.ResultActions
import org.springframework.web.bind.annotation.PathVariable
import org.springframework.web.bind.annotation.PostMapping
import org.springframework.web.bind.annotation.RequestBody
import org.springframework.web.bind.annotation.RequestHeader
import org.springframework.web.bind.annotation.RestController
import java.time.OffsetDateTime
import java.util.UUID

@ExtendWith(SpringExtension::class)
@WebMvcTest
@AutoConfigureRestDocs
open class ResourceSnippetIntegrationTest {

    val operationName = "test-${System.currentTimeMillis()}"

    lateinit var resultActions: ResultActions

    @SpringBootApplication
    open class TestApplication {
        lateinit var applicationContext: ConfigurableApplicationContext
        fun main(args: Array<String>) {
            applicationContext = SpringApplication.run(TestApplication::class.java, *args)
        }

        @RestController
        internal open class TestController {

            @PostMapping(path = ["/some/{someId}/other/{otherId}"])
            fun doSomething(
                @PathVariable someId: String,
                @PathVariable otherId: Int?,
                @RequestHeader("X-Custom-Header") customHeader: String,
                @RequestBody testDataHolder: TestDataHolder
            ): ResponseEntity<EntityModel<TestDataHolder>> {
                val resource = EntityModel.of(testDataHolder.copy(id = UUID.randomUUID().toString()))
                val link = linkToCurrentMapping().slash("some").slash(someId).slash("other").slash(otherId).toUri().toString()
                resource.add(Link.of(link, IanaLinkRelations.SELF))
                resource.add(Link.of(link, "multiple"))
                resource.add(Link.of(link, "multiple"))

                return ResponseEntity
                    .ok()
                    .header("X-Custom-Header", customHeader)
                    .body<EntityModel<TestDataHolder>>(resource)
            }

            @PostMapping(path = ["/join"])
            fun join(
                @RequestBody testDataHolder: TestJoinHolder
            ): ResponseEntity<User> {
                val user = User(
                    1L,
                    testDataHolder.loginId,
                    testDataHolder.password,
                    OffsetDateTime.now()
                )

                return ResponseEntity
                    .ok()
                    .body(user)
            }
        }
    }

    internal data class TestDataHolder(
        @field:Length(min = 1, max = 255)
        val comment: String? = null,
        val flag: Boolean = false,
        val count: Int = 0,
        @field:NotEmpty
        val id: String? = null
    )

    internal data class TestJoinHolder(
        val loginId: String,
        val password: String
    )

    internal class User(
        val id: Long,
        val loginId: String,
        val password: String,
        val createdAt: OffsetDateTime
    )
}

fun fieldDescriptors(): FieldDescriptors {
    val fields = ConstrainedFields(ResourceSnippetIntegrationTest.TestDataHolder::class.java)
    return ResourceDocumentation.fields(
        fields.withPath("comment").description("the comment").optional(),
        fields.withPath("flag").description("the flag"),
        fields.withMappedPath("count", "count").description("the count")
    )
}

fun buildFullResourceSnippet(): ResourceSnippet {
    return resource(
        ResourceSnippetParameters.builder()
            .description("description")
            .summary("summary")
            .deprecated(true)
            .privateResource(true)
            .requestFields(fieldDescriptors())
            .responseFields(fieldDescriptors().and(fieldWithPath("id").description("id")))
            .requestHeaders(
                headerWithName("X-Custom-Header").description("A custom header"),
                headerWithName(ACCEPT).description("Accept")
            )
            .responseHeaders(
                headerWithName("X-Custom-Header").description("A custom header"),
                headerWithName(CONTENT_TYPE).description("ContentType")
            )
            .pathParameters(
                parameterWithName("someId").description("some id"),
                parameterWithName("otherId").description("otherId id").type(SimpleType.INTEGER)
            )
            .links(
                linkWithRel("self").description("some"),
                linkWithRel("multiple").description("multiple")
            )
            .build()
    )
}