Spring Rest Docs를 Markdown으로 작성하기

Spring·2018.04.26 08:43

이번에 새로 시작하는 프로젝트에 Spring Rest Docs를 적용해보기로 했습니다.
Spring Rest Docs를 처음 들어보시는 분들을 위해 간단하게 소개하자면, 테스트 코드를 기반으로 문서를 자동으로 생성해주는 프로젝트입니다.
팀의 API 문서 자동화를 위해 선택하게 되었는데요, Swagger가 가지고 있는 단점들을 충분히 커버해줄만하다는 생각에 선택하게 되었습니다.

Spring Boot Rest Docs의 기본 조합인 Mock MVC & Asciidoc 을 사용하지 않고, Spock & Rest Assured & Markdown을 써야겠다고 생각했는데요.

  • 이미 Groovy & Spock 기반으로 동적 언어로 테스트 코드 작성이 익숙한 상태
    • 문서화를 위해 테스트 프레임워크를 변경하는건 배보다 배꼽이 크다는 생각
  • Mock MVC보다는 Rest Assured가 API 테스트 코드에 좀 더 직관적이라고 생각
  • 팀 내 위키를 비롯한 많은 문서들이 Markdown 기반으로 진행
    • Asciidoc을 별도로 팀 전원이 익히는건 낭비라고 생각

이번 포스팅은 Spring Rest Docs를 Markdown으로 관리하기이지만, 끝까지 읽어보시면 귀찮더라도 Asciidoc을 배워서 쓰자란 결론이 나오실 것 같습니다.
Spock, Rest Assured는 괜찮습니다. 같이 쓰셔도 좋습니다.
Markdown을 함께 쓰기가 너무 불편합니다.
저는 그냥 Asciidoc을 써야겠다고 생각했습니다. ㅠㅠ
혹시나 Markdown을 써야하는 분들이 계실까봐 정리해놓습니다.

모든 코드는 Github에 있으니 참고하시면 좋을것 같습니다.

프로젝트 환경은 스프링부트 2.0.1, Gradle 기반입니다.

1. 프로젝트 생성

프로젝트를 생성하시고 build.gradle을 다음과 같이 작성합니다.
먼저 Rest Assured를 위한 의존성들을 추가합니다.

...
dependencies {
    ...
    testCompile('io.rest-assured:rest-assured:3.0.2') // for rest assured
    testCompile('org.springframework.restdocs:spring-restdocs-restassured') // for rest assured
    ...
}

spock을 위한 의존성과 플러그인을 설치합니다.

...
apply plugin: 'groovy' // for spock
...
dependencies {
    ...
    testCompile('org.spockframework:spock-core:1.1-groovy-2.4') // for spock
    testCompile('org.spockframework:spock-spring:1.1-groovy-2.4') //for spock
}

마지막으로 Markdown으로 Rest Docs를 작성할 수 있게 Gradle Task를 추가합니다.

...
ext {
    snippetsDir = file('build/generated-snippets') // rest docs로 markdown 파일들이 생성되는 위치
}

test {
    outputs.dir snippetsDir
}

// bundleInstall Task
task(bundleInstall, type: Exec) {
    workingDir file('slate') // slate 디렉토리에서
    executable 'bundle' // bundle 이란 명령어를 수행한다.
    args 'install' // bundle 명령어의 인자값으로 install 추가
}

// slate Task
task(slate, type: Exec) {
    dependsOn 'bundleInstall', 'test'
    workingDir file('slate')
    executable 'bundle'
    args 'exec', 'middleman', 'build', '--verbose' // debug mode
}

build {
    dependsOn 'slate'
}
...
  • bundleInstall Task
    • slate 디렉토리에서 bundle install를 수행하는것과 동일합니다.
  • slate Task
    • slate 디렉토리에서 bundle exec middleman build --verbose를 수행하는것과 동일합니다.
    • --verbose는 디버그 모드로 수행하겠다는 의미입니다.

위 Task들의 순서는 dependsOn에 따라 test -> bundleInstall -> slate -> build가 됩니다.

이렇게 하시면 build.gradle의 전체 코드는 아래와 같습니다.

buildscript {
    ext {
        springBootVersion = '2.0.1.RELEASE'
    }
    repositories {
        mavenCentral()
    }
    dependencies {
        classpath("org.springframework.boot:spring-boot-gradle-plugin:${springBootVersion}")
    }
}

apply plugin: 'groovy' // for spock
apply plugin: 'java'
apply plugin: 'eclipse'
apply plugin: 'org.springframework.boot'
apply plugin: 'io.spring.dependency-management'

group = 'com.jojoldu'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = 1.8
targetCompatibility = 1.8

repositories {
    mavenCentral()
}

ext {
    snippetsDir = file('build/generated-snippets')
}

test {
    outputs.dir snippetsDir // 자동 생성되는 마크다운 파일들이 저장될 장소
}

task(bundleInstall, type: Exec) {
    workingDir file('slate')
    executable 'bundle'
    args 'install'
}

task(slate, type: Exec) {
    dependsOn 'bundleInstall', 'test'
    workingDir file('slate')
    executable 'bundle'
    args 'exec', 'middleman', 'build', '--verbose' // debug mode
}

build {
    dependsOn 'slate'
}

dependencies {
    compile('org.springframework.boot:spring-boot-starter-data-jpa')
    compile('org.springframework.boot:spring-boot-starter-web')

    runtime('com.h2database:h2')

    compileOnly('org.projectlombok:lombok')

    testCompile('io.rest-assured:rest-assured:3.0.2') // for rest assured
    testCompile('org.springframework.restdocs:spring-restdocs-restassured') // for rest assured
    testCompile('org.springframework.boot:spring-boot-starter-test')
    testCompile('org.spockframework:spock-core:1.1-groovy-2.4') // for spock
    testCompile('org.spockframework:spock-spring:1.1-groovy-2.4') //for spock
}

자 이렇게 하면 프로젝트의 기본 의존성들은 다 추가되었습니다!

2. slate 추가

Markdown으로 Rest Docs를 작성하려면 Ruby 프로젝트인 slate가 필요합니다.

slate-example1

(slate로 만든 대표적인 API: Travis CI API)

Gradle로 관리되는 프로젝트가 아니기 때문에 프로젝트를 직접 Download받아서 진행해야만 합니다.
아래 쉘 명령어를 차례로 입력합니다.

# 현재 프로젝트로 이동
cd 현재 프로젝트 디렉토리

# slate download
wget https://github.com/lord/slate/archive/master.zip

# 압축 해제
unzip master.zip

# 해제된 디렉토리명 수정
mv ./slate-master ./slate

# zip 파일 제거
rm ./master.zip

요렇게 다 받으셨으면 프로젝트에 다음과 같이 slate 디렉토리에 파일들이 있어야 합니다.

slate1

자 그럼 slate가 사용할 Ruby 라이브러리들을 받아야 하는데요.
이를 위해 Ruby 라이브러리 관리를 진행해줄 bundler을 설치하겠습니다.

Ruby가 설치되어 있으시다면 아래 명령어를 바로 입력합니다.

gem install bundler

참고: Mac에 기본 설치된 Ruby를 이용하시면 Permission Denied 문제가 발생할 수 있습니다.
그럴 경우 이전 포스팅를 참고해 문제를 해결하시고 계속 진행해주세요.

bundler도 설치가 완료 되셨으면 개발환경 구축은 끝입니다!
바로 문서를 만들어보겠습니다.

3. Markdown 및 테스트 코드 작성

3-1. 메인 Markdown 작성

Rest Docs가 테스트 코드를 기반으로 문서를 만들어 준다해도, 전체적인 구조와 내용을 잡아주는 index용 Markdown 파일이 필요합니다.
slate/source/ 아래에 있는 index.html.md 파일을 복사하여, 같은 위치에 api-guide.html.md.erb 파일을 생성합니다.

slate2

erb라는 확장자가 생소하실텐데요.
Ruby의 템플릿엔진입니다.
(일종의 JSP, Freemarker, Handlebars와 같다고 보시면 됩니다.)

이 확장자를 써야하는 이유는 간단합니다.
Markdown은 import 기능이 없기 때문입니다.
Asciidoc의 경우 import가 지원되지만, Markdown은 그런 기능이 없기 때문에 Ruby의 템플릿엔진을 통해 다른 Markdown 파일을 import시키는 것입니다.

방금 생성한 api-guide.html.md.erb에 간단한 내용을 추가합니다.

---
title: REST Notes API Guide

language_tabs:
  - http

search: true
---

# Overview


## HTTP Method

Restful API


Method     | Usage
-------- | -----
`GET`    | 조회
`POST`   | 등록
`PUT`    | 수정
`DELETE` | 삭제

여기까지만 작성하고 저장한 뒤, 터미널을 열어 ./gradlew build를 수행합니다.
그러면 아래처럼 slate/build 안에 api-guide.html파일이 생성됩니다.

즉, XXX.md.erb 파일에서 XXX란 이름으로 자동생성되는것을 알 수 있습니다.

slate3

이 파일을 열어보시면!

slate4

저희가 작성한 Markdown 내용이 잘 반영된 API 문서를 볼 수 있습니다!
대략 어떤 흐름인지 아시겠죠?

  • build 실행
  • slate가 slate/source/***.md.erb 파일을 기준으로 API 문서 생성

나중에 실제 프로젝트로 진행되다면 jar파일로 패키징 되기 전에 slate로 생성된 html파일을 src/main/resources/static 안에 넣어주시면 됩니다.
그럼 스프링부트에서 도메인/XXX.html로 URL을 자동으로 매핑해줍니다.

여기까지는 개발자가 직접 Markdown을 작성한 내용을 자동 문서화 시켜주었습니다.
그럼 이제 테스트 코드를 통해서 문서 자동화를 진행해보겠습니다.

3-2. 테스트 코드 작성

import io.restassured.builder.RequestSpecBuilder
import io.restassured.http.ContentType
import io.restassured.specification.RequestSpecification
import org.junit.Rule
import org.springframework.boot.test.context.SpringBootTest
import org.springframework.boot.web.server.LocalServerPort
import org.springframework.restdocs.JUnitRestDocumentation
import org.springframework.restdocs.payload.JsonFieldType
import spock.lang.Specification

import static io.restassured.RestAssured.given
import static org.hamcrest.CoreMatchers.is
import static org.springframework.restdocs.operation.preprocess.Preprocessors.*
import static org.springframework.restdocs.payload.PayloadDocumentation.*
import static org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.document
import static org.springframework.restdocs.restassured3.RestAssuredRestDocumentation.documentationConfiguration
import static org.springframework.restdocs.templates.TemplateFormats.markdown

@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
class WebControllerTest extends Specification {

    @Rule
    public JUnitRestDocumentation restDocumentation = new JUnitRestDocumentation() // 문서 자동생성 규칙을 담은 인스턴스

    private RequestSpecification spec

    @LocalServerPort
    private int port

    /**
        현재 컨트롤러에서 진행되는 모든 테스트 메소드들이 
        Request 요청시 문서자동화 과정을 거치도록 지정
    **/
    void setup() {
        this.spec = new RequestSpecBuilder()
                .addFilter(
                documentationConfiguration(restDocumentation)
                        .snippets()
                        .withTemplateFormat(markdown())) // Rest Docs 생성 템플릿 지정
                .build()
    }

    def "Request & Response 설명" () {
        expect:
        def requestDto = RequestDto.builder()
                .age(32)
                .name("jojoldu")
                .email("jojoldu@gmail.com")
                .build()

        given(this.spec)
                .accept("application/json")
                .contentType(ContentType.JSON)
                .filter(document( // document 메소드 인자값을 기준으로 Markdown 생성
                "email-sample", // 현재 테스트로 생성되는 Markdown 파일들이 담길 디렉토리명
                preprocessRequest(
                        modifyUris() // 문서상 표기되는 URL과 Port 지정
                                .host('api.jojoldu.tistory.com')
                                .removePort()),
                preprocessResponse(prettyPrint()),
                requestFields( // request field 설명하는 Markdown 생성
                        fieldWithPath('name').description('이름'),
                        fieldWithPath('age').description('나이'),
                        fieldWithPath('email').description('Email'),
                        subsectionWithPath('tags').type(JsonFieldType.ARRAY).description('tag 목록')
                ),
                responseFields( // response field 설명하는 Markdown 생성
                        fieldWithPath('status').description('응답 상태 코드'),
                        fieldWithPath('message').description('응답 메세지'),
                )))
                .when()
                .port(this.port)
                .body(requestDto) // request body data
                .post("/email") // request url
                .then()
                .assertThat().statusCode(is(200))
                .assertThat().body("status", is("OK"))
                .assertThat().body("message", is("jojoldu@gmail.com"))
    }
}
  • 기본적으로 JUnitRestDocumentation은 프로젝트의 빌드 도구를 기반으로 자동생성되는 파일들을 담을 디렉토리를 자동 지정합니다.
    • maven: target/generated-snippets
    • gradle: build/generated-snippets

테스트 메소드 (Request & Response 설명) 코드가 실질적으로 자동생성되는 Markdown 내용이 담겨 있습니다.

  • "email-sample"
    • 위 테스트 메소드 하나로 자동생성되는 Markdown 파일은 최소 5개 이상입니다.
    • 이 마크다운 파일들이 담길 snippets 디렉토리명을 지정합니다.
  • requestFields
    • Request Body의 필드들 설명문을 자동생성해줍니다.
    • description, type 등 다양한 내용을 담을 수 있습니다.
    • 주의: DTO 필드명이 모두 명시되어있어야합니다. 누락될 경우 테스트가 깨집니다.
  • responseFields
    • Response Body의 필드들 설명문을 자동생성해줍니다.
    • 사용법과 주의사항은 requestFields와 동일합니다.

좀 더 다양하고 자세한 문서를 만들고 싶으시면 공식 API 문서를 참고해보세요!

자 이제 이 테스트 내용들을 api-guide.html에 추가되야만 하는데요.

api-guide.html을 담당하는 api-guide.html.md.erb파일로 갑니다.
파일 최 하단에 다음과 같은 코드를 추가합니다.

## 경로

현재 위치의 절대 경로

<%= File.expand_path("..") %>

## Default Sample

기본 요청

<%= ERB.new(File.read("../build/generated-snippets/email-sample/request-fields.md")).result(binding) %>
<%= ERB.new(File.read("../build/generated-snippets/email-sample/curl-request.md")).result(binding) %>
<%= ERB.new(File.read("../build/generated-snippets/email-sample/http-request.md")).result(binding) %>
<%= ERB.new(File.read("../build/generated-snippets/email-sample/http-response.md")).result(binding) %>


### Response structure

<%= ERB.new(File.read("../build/generated-snippets/email-sample/response-fields.md")).result(binding) %>
<%= ERB.new(File.read("../build/generated-snippets/email-sample/response-body.md")).result(binding) %>

위에서 이야기한것처럼 Markdown은 import 기능이 없습니다.
이를 Ruby 템플릿엔진인 ERB의 템플릿 문법을 사용해서 추가하였습니다.
주의하실 것은 상대경로로 파일위치를 지정하였는데요.
상대경로의 기준은 slate 디렉토리입니다.
즉, ../build/generated-snippets는 사실은 프로젝트폴더/build/generated-snippets가 됩니다.

../로 하면 slate 디렉토리의 상위 디렉토리인 프로젝트가 지정되기 때문입니다.

자 본문에 테스트 코드로 자동생성되는 Markdown 파일들도 import 되었으니 다시한번 Build를 진행해보겠습니다.

./gradlew clean build

자 그리고 slate/build/api-guide.html 을 열어봅니다.
그러면!

slate5

테스트 코드에 작성한 내용이 아주 잘 반영된 문서를 볼 수 있습니다!

5. 결론?

저는 일단 Markdown으로 Rest Docs 작성하는걸 포기했습니다.
몇가지 큰 이유가 있었는데요.

  • slate에 의존해야만 하는 구조
    • 팀 구성원 전체가 Ruby & Gem을 설치하고 bundler까지 설치해야하는게 너무 번잡합니다.
  • 만들어지는 문서가 기존 스프링 관련 문서들에 비해 UI가 친숙하지 않습니다.
  • 빌드시간이 너무 오래 걸립니다.
    • Ruby 의존성들이 많아 빌드시간이 전체적으로 너무 오래걸립니다.

다음 시간엔 기본 버전인 Asciidoc으로 진행하는 방법을 소개드리겠습니다.
훨씬 더 간편하게 문서가 자동화 됩니다.
Asciidoc은 실제 프로젝트에 적용되는걸 기준으로 소개드리겠습니다.

긴 글 끝까지 읽어주셔서 감사합니다 :)

참고

블로그가 도움이 되셨다면 아래 광고 클릭을 부탁드립니다!

좋은 리뷰와 광고클릭은 앞으로 계속 글을 쓰는데 큰 힘이 됩니다!


Posted by 창천향로 창천향로

태그

티스토리 툴바