REST Docs + Epages 조합 API Document Generate

[meloning]

프로젝트 root 내 build.gradle.kts

plugins {
    id("org.springframework.boot") apply false
    id("io.spring.dependency-management") apply false

    id("org.jmailen.kotlinter")

    id("com.epages.restdocs-api-spec") apply false  // epages 플러그인 추가 version은 settings.gradle에서 적용할 것.

    kotlin("jvm")
    kotlin("kapt")
    kotlin("plugin.spring") apply false
    kotlin("plugin.jpa") apply false
}

...

val restDocsProject = listOf(
    project(":mega-coffee-api"), // Admin API가 추가될 수 있으니 list로 미리 선언
)
configure(restDocsProject) {
    apply(plugin = "com.epages.restdocs-api-spec")

    extensions.extraProperties["snippetsDir"] = file("build/generated-snippets")

    val epagesVersion: String by project

    dependencies {
        testImplementation("org.springframework.restdocs:spring-restdocs-mockmvc")

        testImplementation("com.epages:restdocs-api-spec:$epagesVersion")
        testImplementation("com.epages:restdocs-api-spec-mockmvc:$epagesVersion")
    }

    /**
     * @see <a href="https://github.com/ePages-de/restdocs-api-spec">Spring REST Docs API specification Integration</a>
     */
    configure<OpenApi3Extension> {
        setServer("http://localhost:9000")
        title = "MGC Employee Manage OpenApi Specification"
        version = "1.0.0"
        format = "yaml"
    }

    tasks.named("bootJar") {
        doLast {
            val sourceDir = project.file("swagger-ui")
            val yamlFile = project.file("${project.buildDir}/api-spec/openapi3.yaml")
            val targetDir = project.file("build/classes/kotlin/main/BOOT-INF/classes/static/swagger-ui")

            copy {
                from(sourceDir) {
                    into(targetDir)
                }
                from(yamlFile) {
                    into(targetDir)
                }
            }
        }
    }
}

이렇게 구성한 후 Redoc으로 열어서 API 문서들을 확인하면 될것 같다.

[meloning]

[Result]

원하는 문서 Output이 나오게 된거 같아 기쁘다.

이제 Github Action을 통해 변경된 문서를 반영할 수 있도록 Pipeline을 구축하면 될 것 같다.

[meloning]

[API Document URL]
https://meloning.github.io/redoc-meloning-api/