Feat/auth

.github/workflows/CI.yml

@@ -50,6 +50,12 @@ jobs:
           mysql user: 'test'
           mysql password: 'test_pw'
 
+      #테스트를 위한 redis 설정
+      - name: Start Redis
+        uses: supercharge/redis-github-action@1.5.0
+        with:
+          redis-port: 6376
+
       #테스트를 위한 test yml 설정
       - name: Make application-test.yml
         run: |

README.md

@@ -25,3 +25,7 @@
 - MySQL(RDB)
 - Git, Github Actions CI/CD
 - CloudWatch, Slack
+
+### API 명세서
+
+[사용자 API 명세서](https://odoichon.github.io/server/src/main/resources/static/docs/user.html)

src/docs/asciidoc/index.adoc

@@ -14,3 +14,5 @@ endif::[]
 :toc: left
 :toclevels: 5
 :sectlinks:
+
+include::user.adoc[]

src/docs/asciidoc/user.adoc

@@ -0,0 +1,61 @@
+== User API
+
+=== 1. 회원가입
+===== Request
+include::{snippets}/sign-up/http-request.adoc[]
+===== Response
+include::{snippets}/sign-up/http-response.adoc[]
+
+=== 2. 로그인
+===== Request
+include::{snippets}/sign-in/http-request.adoc[]
+===== Response
+include::{snippets}/sign-in/http-response.adoc[]
+
+=== 3. 토큰 재발급
+===== Request
+include::{snippets}/reissue/http-request.adoc[]
+===== Response
+include::{snippets}/reissue/http-response.adoc[]
+
+=== 4. 로그아웃
+===== Request
+include::{snippets}/logout/http-request.adoc[]
+===== Response
+include::{snippets}/logout/http-response.adoc[]
+
+=== 5. 이메일 중복 검사
+===== Request
+include::{snippets}/email-check/http-request.adoc[]
+===== Response
+include::{snippets}/email-check/http-response.adoc[]
+
+=== 6. 닉네임 중복 검사
+===== Request
+include::{snippets}/nickname-check/http-request.adoc[]
+===== Response
+include::{snippets}/nickname-check/http-response.adoc[]
+
+=== 7. 인증문자 전송
+===== Request
+include::{snippets}/send-sms/http-request.adoc[]
+===== Response
+include::{snippets}/send-sms/http-response.adoc[]
+
+=== 8. 인증문자 검증
+===== Request
+include::{snippets}/check-sms/http-request.adoc[]
+===== Response
+include::{snippets}/check-sms/http-response.adoc[]
+
+=== 9. 닉네임 수정
+===== Request
+include::{snippets}/update-nickname/http-request.adoc[]
+===== Response
+include::{snippets}/update-nickname/http-response.adoc[]
+
+=== 10. 비밀번호 수정
+===== Request
+include::{snippets}/update-password/http-request.adoc[]
+===== Response
+include::{snippets}/update-password/http-response.adoc[]