Portfolio


plugins {
    id 'org.springframework.boot' version '2.7.1'
    id 'io.spring.dependency-management' version '1.0.11.RELEASE'
    id 'org.asciidoctor.jvm.convert' version '3.3.2'. // (1)
    id 'java'
}

group = 'com.example'
version = '0.0.1-SNAPSHOT'
sourceCompatibility = '11'

configurations {
    asciidoctorExtensions   // (2)
}

repositories {
    mavenCentral()
}

ext {
    set('snippetsDir', file("build/generated-snippets")) // (3)
}

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-web'
    asciidoctorExtensions 'org.springframework.restdocs:spring-restdocs-asciidoctor' // (4)
    testImplementation 'org.springframework.boot:spring-boot-starter-test'
    testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc' // (5)
}

tasks.named('test') {
    outputs.dir snippetsDir
    useJUnitPlatform()
}

tasks.named('asciidoctor') {  // (6)
    configurations 'asciidoctorExtensions'
    sources{
        include("**/index.adoc")
    }
    baseDirFollowsSourceFile()
    inputs.dir snippetsDir
    dependsOn test
}

asciidoctor.doFirst {     //(7)
    delete file('src/main/resources/static/docs')
}

task createDocument(type: Copy) {       // (8)
    dependsOn asciidoctor

    from file("build/docs/asciidoc")
    into file("src/main/resources/static")
}

bootJar {       // (9)
    dependsOn createDocument
}


@RestController
public class TestController {

	@GetMapping("/users")
	public ResponseEntity<TestResponse> get() {
		return ResponseEntity.ok(new TestResponse("test"));
	}


@SpringBootTest
@AutoConfigureMockMvc
@AutoConfigureRestDocs
class TestControllerTest {

	@Autowired
	private MockMvc mockMvc;

	@Autowired
	private ObjectMapper objectMapper;


	@DisplayName("레스트 독스 테스트")
	@Test
	void TestControllerTest() throws Exception {
	    // given

		// when
		mockMvc.perform(get("/users")
				.contentType(MediaType.APPLICATION_JSON_VALUE))
			.andExpectAll(
				status().isOk(),
				jsonPath("name").value("test")
			)

			// then
			.andDo(document("test",
				preprocessRequest(prettyPrint()),
				preprocessResponse(prettyPrint()),
				responseFields(
					fieldWithPath("name").type(JsonFieldType.STRING).description("테스트")
				)));
	}

}


ifndef::snippets[]
:snippets: ../../../build/generated-snippets
endif::[]
:doctype: book
:icons: font
:source-highlighter: highlightjs
:toc: left
:toclevels: 3
:sectlinks:
:docinfo: shared-head


== 예약 게스트 API

=== 예약 생성

==== Request

===== Request HTTP Example

include::{snippets}/test/http-request.adoc[]

==== Response

include::{snippets}/test/response-fields.adoc[]

===== Response HTTP Example

include::{snippets}/test/http-response.adoc[]