[BE] docs: GitHub 연동, 자신이 만든 리뷰 그룹 목록 조회 API 문서 작성

backend/src/docs/asciidoc/auth.adoc

@@ -0,0 +1,7 @@
+==== 깃허브로 로그인/회원가입
+
+operation::github-auth[snippets="curl-request,request-fields,http-response"]
+
+==== 로그아웃
+
+operation::logout[snippets="curl-request,request-cookies,http-response"]

backend/src/docs/asciidoc/index.adoc

@@ -40,3 +40,7 @@ include::review-gather.adoc[]
 === 답변 하이라이트
 
 include::highlight-answers.adoc[]
+
+== 인증
+
+include::auth.adoc[]

backend/src/main/java/reviewme/auth/controller/AuthController.java

@@ -0,0 +1,49 @@
+package reviewme.auth.controller;
+
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpSession;
+import jakarta.validation.Valid;
+import lombok.RequiredArgsConstructor;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.ResponseCookie;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RestController;
+import reviewme.auth.service.AuthService;
+import reviewme.auth.service.dto.GithubCodeRequest;
+
+@RestController
+@RequiredArgsConstructor
+public class AuthController {
+
+    private final AuthService authService;
+
+    @PostMapping("/v2/auth/github")
+    public ResponseEntity<Void> authWithGithub(
+            @Valid @RequestBody GithubCodeRequest request,
+            HttpServletRequest httpRequest
+    ) {
+        return ResponseEntity.ok().build();
+    }
+
+    @PostMapping("/v2/auth/logout")
+    public ResponseEntity<Void> logout(
+            HttpServletRequest httpRequest
+    ) {
+        HttpSession session = httpRequest.getSession();
+        session.invalidate();
+
+        ResponseCookie cookie = ResponseCookie.from("JSESSIONID", "")
+                .path("/")
+                .maxAge(0)
+                .secure(true)
+                .httpOnly(true)
+                .build();
+
+        return ResponseEntity
+                .noContent()
+                .header(HttpHeaders.SET_COOKIE, cookie.toString())
+                .build();
+    }
+}

backend/src/main/java/reviewme/auth/service/AuthService.java

@@ -0,0 +1,7 @@
+package reviewme.auth.service;
+
+import org.springframework.stereotype.Service;
+
+@Service
+public class AuthService {
+}

backend/src/main/java/reviewme/auth/service/dto/GithubCodeRequest.java

@@ -0,0 +1,8 @@
+package reviewme.auth.service.dto;
+
+import jakarta.validation.constraints.NotBlank;
+
+public record GithubCodeRequest(
+        @NotBlank(message = "깃허브 임시 코드를 입력해주세요.")
+        String code) {
+}

backend/src/test/java/reviewme/api/ApiTest.java

@@ -26,6 +26,8 @@
 import org.springframework.test.web.servlet.MockMvc;
 import org.springframework.test.web.servlet.setup.MockMvcBuilders;
 import org.springframework.web.context.WebApplicationContext;
+import reviewme.auth.controller.AuthController;
+import reviewme.auth.service.AuthService;
 import reviewme.highlight.controller.HighlightController;
 import reviewme.highlight.service.HighlightService;
 import reviewme.review.controller.ReviewController;
@@ -48,7 +50,8 @@
         ReviewController.class,
         TemplateController.class,
         SectionController.class,
-        HighlightController.class
+        HighlightController.class,
+        AuthController.class
 })
 @ExtendWith(RestDocumentationExtension.class)
 public abstract class ApiTest {
@@ -85,6 +88,9 @@ public abstract class ApiTest {
     @MockBean
     protected HighlightService highlightService;
 
+    @MockBean
+    protected AuthService authService;
+
     @MockBean
     private ReviewGroupSessionResolver reviewGroupSessionResolver;
 

backend/src/test/java/reviewme/api/AuthApiTest.java

@@ -0,0 +1,61 @@
+package reviewme.api;
+
+import static org.hamcrest.Matchers.containsString;
+import static org.springframework.restdocs.cookies.CookieDocumentation.cookieWithName;
+import static org.springframework.restdocs.cookies.CookieDocumentation.requestCookies;
+import static org.springframework.restdocs.mockmvc.MockMvcRestDocumentation.document;
+import static org.springframework.restdocs.payload.PayloadDocumentation.fieldWithPath;
+import static org.springframework.restdocs.payload.PayloadDocumentation.requestFields;
+
+import org.junit.jupiter.api.Test;
+import org.springframework.restdocs.cookies.CookieDescriptor;
+import org.springframework.restdocs.mockmvc.RestDocumentationResultHandler;
+import org.springframework.restdocs.payload.FieldDescriptor;
+
+public class AuthApiTest extends ApiTest {
+
+    @Test
+    void 깃허브로_인증한다() {
+        String request = """
+                {
+                     "code": "github_auth_code"
+                }
+                """;
+
+        FieldDescriptor[] requestFieldDescriptors = {
+                fieldWithPath("code").description("깃허브 임시 인증 코드"),
+        };
+
+        RestDocumentationResultHandler handler = document(
+                "github-auth",
+                requestFields(requestFieldDescriptors)
+        );
+
+        givenWithSpec().log().all()
+                .body(request)
+                .when().post("/v2/auth/github")
+                .then().log().all()
+                .apply(handler)
+                .statusCode(200);
+    }
+
+    @Test
+    void 로그아웃한다() {
+        CookieDescriptor[] cookieDescriptors = {
+                cookieWithName("JSESSIONID").description("세션 ID")
+        };
+
+        RestDocumentationResultHandler handler = document(
+                "logout",
+                requestCookies(cookieDescriptors)
+        );
+
+        givenWithSpec().log().all()
+                .cookie("JSESSIONID", "SESSION12345678")
+                .when().post("/v2/auth/logout")
+                .then().log().all()
+                .apply(handler)
+                .statusCode(204)
+                .header("Set-Cookie", containsString("JSESSIONID=; Path=/; Max-Age=0"));
+    }
+}