Skip to content

MSTR-100 : 회원 API REST Docs 작성 #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 16 commits into from
Jul 19, 2022
Merged

MSTR-100 : 회원 API REST Docs 작성 #6

merged 16 commits into from
Jul 19, 2022

Conversation

kshired
Copy link
Member

@kshired kshired commented Jul 19, 2022

Issue Number

close: MSTR-100

작업 내역

구현 내용 및 작업 했던 내역

  • Spring REST Docs 세팅 완료
  • 회원 관련 API REST Docs 작성 완료
  • 토큰 refresh bug fix
  • 비밀 값을 서브 모듈로 분리
  • dev 브랜치에 merge시 자동으로 netlify에 Documentation을 배포하는 action 추가

변경사항

  • dependency 추가
    • Spring REST Docs 및 Asciidoc 추가

작업 유형

  • 신규 기능 추가
  • 버그 수정
  • 리펙토링
  • 문서 업데이트

PR 특이 사항

PR을 볼 때 주의깊게 봐야하거나 말하고 싶은 점

  • Spring REST Docs를 추가하였습니다.
  • 토큰 refresh시 access token의 validation을 잘못하고 있던 버그를 수정했습니다.
  • private repository를 이용하여 서브모듈 로 yml 파일을 이동하였습니다.

kshired added 6 commits July 18, 2022 15:44
- 기본적인 구조 설정
- Login, SignUp API Docs 작성
- 만료된 토큰을 잘못된 방법으로 validation하던 버그 fix
- 토큰 재발급 API 테스트 추가
- 재발급 API Docs를 위한 index 수정
requestFields(
fieldWithPath("email").type(JsonFieldType.STRING).description("이메일"),
fieldWithPath("username").type(JsonFieldType.STRING).description("닉네임"),
fieldWithPath("password").type(JsonFieldType.STRING).description("비밀번호"),
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [ktlint] reported by reviewdog 🐶
Unnecessary trailing comma before ")"

preprocessResponse(prettyPrint()),
requestFields(
fieldWithPath("email").type(JsonFieldType.STRING).description("이메일"),
fieldWithPath("password").type(JsonFieldType.STRING).description("비밀번호"),
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [ktlint] reported by reviewdog 🐶
Unnecessary trailing comma before ")"

@kshired kshired requested review from ekzm8523 and Kim-Hyunjo July 19, 2022 02:18
@kshired kshired temporarily deployed to commit July 19, 2022 04:42 Inactive
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

Copy link
Member

@Kim-Hyunjo Kim-Hyunjo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rest docs 확인했습니다! 넘 깔끔하네용👍

@kshired kshired merged commit b4f770a into dev Jul 19, 2022
@kshired kshired deleted the feat/100 branch August 11, 2022 06:00
@kshired kshired self-assigned this Mar 24, 2023
@kshired kshired added the documentation Improvements or additions to documentation label Mar 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants