Merge pull request #36 from f-lab-edu/feature/35

[#35] restdocs도입

build.gradle

@@ -3,6 +3,11 @@ plugins {
     id 'groovy'
     id 'org.springframework.boot' version '3.2.1'
     id 'io.spring.dependency-management' version '1.1.4'
+    id "org.asciidoctor.jvm.convert" version "3.3.2"
+}
+
+configurations {
+    asciidoctorExt
 }
 
 group = 'com'
@@ -38,6 +43,8 @@ dependencies {
     testImplementation 'org.springframework.security:spring-security-test'
     implementation 'org.springframework.session:spring-session-data-redis'
     testImplementation 'org.springframework.batch:spring-batch-test'
+    testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc'
+    asciidoctorExt 'org.springframework.restdocs:spring-restdocs-asciidoctor'
 
     // 구글 지오코딩 api
     implementation 'com.google.maps:google-maps-services:2.2.0'
@@ -52,6 +59,43 @@ dependencies {
     testAnnotationProcessor 'org.projectlombok:lombok'
 }
 
+ext {
+    snippetsDir = file('build/generated-snippets')
+}
+
+test {
+    outputs.dir snippetsDir
+}
+
+bootJar {
+    dependsOn asciidoctor
+    from ("${asciidoctor.outputDir}/html5") {
+        into 'static/docs'
+    }
+}
+
 tasks.named('test') {
     useJUnitPlatform()
 }
+
+
+asciidoctor {
+    inputs.dir snippetsDir
+    configurations 'asciidoctorExt'
+    dependsOn test
+    baseDirFollowsSourceFile()
+}
+
+asciidoctor.doFirst {
+    delete file('src/main/resources/static/docs')
+}
+
+task copyDocument(type: Copy) {
+    dependsOn asciidoctor
+    from file("build/docs/asciidoc")
+    into file("src/main/resources/static/docs")
+}
+
+build {
+    dependsOn copyDocument
+}

src/docs/asciidoc/CancelLike.adoc

@@ -0,0 +1,2 @@
+== Like a feed
+operation::like-controller-test/Cancel like[snippets="http-request,http-response,path-parameters"]

src/docs/asciidoc/CreateADiary.adoc

@@ -0,0 +1,2 @@
+== Create a diary
+operation::diary-controller-test/Create a diary[snippets="http-request,http-response"]

src/docs/asciidoc/CreateChildComment.adoc

@@ -0,0 +1,2 @@
+== Create a nested comment
+operation::comment-controller-test/Create child comment[snippets="http-request,http-response,path-parameters"]

src/docs/asciidoc/CreateComment.adoc

@@ -0,0 +1,2 @@
+== Create a comment
+operation::comment-controller-test/Create comment[snippets="http-request,http-response,path-parameters"]

src/docs/asciidoc/CreateFeed.adoc

@@ -0,0 +1,2 @@
+== Create a feed
+operation::feed-controller-test/Create Feed[snippets="http-request,http-response"]

src/docs/asciidoc/DeleteADiary.adoc

@@ -0,0 +1,2 @@
+== Delete a diary
+operation::diary-controller-test/Delete a diary[snippets="http-request,http-response,path-parameters"]

src/docs/asciidoc/DeleteAFeed.adoc

@@ -0,0 +1,2 @@
+== Get a feed
+operation::feed-controller-test/Delete a feed[snippets="http-request,http-response,path-parameters"]

src/docs/asciidoc/DeleteComments.adoc

@@ -0,0 +1,2 @@
+== Delete a comment
+operation::comment-controller-test/Delete a comment[snippets="http-request,http-response,path-parameters"]

src/docs/asciidoc/GetAFeed.adoc

@@ -0,0 +1,2 @@
+== Get a feed
+operation::feed-controller-test/Get a feed[snippets="http-request,http-response,path-parameters"]

src/docs/asciidoc/GetChildComments.adoc

@@ -0,0 +1,2 @@
+== Get child comments
+operation::comment-controller-test/Get child comments[snippets="http-request,http-response,path-parameters"]

src/docs/asciidoc/GetComments.adoc

@@ -0,0 +1,2 @@
+== Get comments
+operation::comment-controller-test/Get comments[snippets="http-request,http-response,path-parameters,query-parameters"]

src/docs/asciidoc/GetDailyHotFeeds.adoc

@@ -0,0 +1,2 @@
+== Get daily hot feeds
+operation::ranking-controller-test/get daily-hot-feeds[snippets="http-request,http-response"]

src/docs/asciidoc/GetDiariesOfAMember.adoc

@@ -0,0 +1,2 @@
+== Get diaries of a member
+operation::diary-controller-test/Get diaries of a member[snippets="http-request,http-response,path-parameters,query-parameters"]

src/docs/asciidoc/GetFeedsByTag.adoc

@@ -0,0 +1,2 @@
+== Get feeds by tag
+operation::feed-controller-test/Get feeds by tag[snippets="http-request,http-response,path-parameters,query-parameters"]

src/docs/asciidoc/GetFeedsOfMember.adoc

@@ -0,0 +1,2 @@
+== Get feeds of member
+operation::feed-controller-test/Get feeds of member[snippets="http-request,http-response,path-parameters"]

src/docs/asciidoc/GetMonthlyHotFeeds.adoc

@@ -0,0 +1,2 @@
+== Get monthly hot feeds
+operation::ranking-controller-test/get monthly-hot-feeds[snippets="http-request,http-response"]

src/docs/asciidoc/GetPopularAbroadSpots.adoc

@@ -0,0 +1,2 @@
+== Get popular abroad spots
+operation::ranking-controller-test/Get popular abroad spots[snippets="http-request,http-response"]

src/docs/asciidoc/GetPopularDomesticSpots.adoc

@@ -0,0 +1,2 @@
+== Get popular domestic spots
+operation::ranking-controller-test/Get popular domestic spots[snippets="http-request,http-response"]

src/docs/asciidoc/GetWeeklyHotFeeds.adoc

@@ -0,0 +1,2 @@
+== Get weekly hot feeds
+operation::ranking-controller-test/get weekly-hot-feeds[snippets="http-request,http-response"]

src/docs/asciidoc/JoinMember.adoc

@@ -0,0 +1,2 @@
+== JoinMember
+operation::member-controller-test/JoinMember[snippets="http-request,http-response"]

src/docs/asciidoc/LikeAFeed.adoc

@@ -0,0 +1,2 @@
+== Like a feed
+operation::like-controller-test/Like a feed[snippets="http-request,http-response,path-parameters"]

src/docs/asciidoc/UpdateAFeed.adoc

@@ -0,0 +1,2 @@
+== Get a feed
+operation::feed-controller-test/Update a feed[snippets="http-request,http-response,path-parameters"]

src/docs/asciidoc/index.adoc

@@ -0,0 +1,30 @@
+= Stoury API docs
+:doctype: book
+:source-highlighter: highlightjs
+:toc: left
+:toclevels: 2
+:seclinks:
+
+include::JoinMember.adoc[]
+include::CreateFeed.adoc[]
+include::GetAFeed.adoc[]
+include::GetFeedsByTag.adoc[]
+include::GetFeedsOfMember.adoc[]
+include::UpdateAFeed.adoc[]
+include::DeleteAFeed.adoc[]
+include::LikeAFeed.adoc[]
+include::CancelLike.adoc[]
+include::CreateComment.adoc[]
+include::CreateChildComment.adoc[]
+include::GetComments.adoc[]
+include::GetChildComments.adoc[]
+include::DeleteComments.adoc[]
+include::CreateADiary.adoc[]
+include::GetDiariesOfAMember.adoc[]
+include::DeleteADiary.adoc[]
+include::GetPopularDomesticSpots.adoc[]
+include::GetPopularAbroadSpots.adoc[]
+include::GetDailyHotFeeds.adoc[]
+include::GetWeeklyHotFeeds.adoc[]
+include::GetMonthlyHotFeeds.adoc[]
+