Skip to content
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.

Sign up for GitHub

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

Jump to bottom

๐Ÿš€ Restdocs๋ฅผ ํ™œ์šฉํ•œ #OOTW API ๋ช…์„ธ์„œ ์ž‘์„ฑ #75

Merged
merged 32 commits into from
Jan 18, 2024
Merged

๐Ÿš€ Restdocs๋ฅผ ํ™œ์šฉํ•œ #OOTW API ๋ช…์„ธ์„œ ์ž‘์„ฑ #75

merged 32 commits into from
Jan 18, 2024

Conversation

ASak1104
Copy link
Collaborator

@ASak1104 ASak1104 commented Jan 17, 2024 •
edited
Loading

โœ… ์š”๊ตฌ์‚ฌํ•ญ

๐Ÿš€ ์ฃผ์š” ๋ณ€๊ฒฝ์‚ฌํ•ญ

  • Restdocs ์„ค์ •
  • UserController ๋ช…์„ธ
  • CertificateController ๋ช…์„ธ
  • AvatarItemController ๋ช…์„ธ
  • PostController ๋ช…์„ธ
  • LikeController ๋ช…์„ธ
  • WeatherController ๋ช…์„ธ
  • Bearer Token ์— ๋Œ€ํ•œ Required ์—ฌ๋ถ€ ์ •์˜
  • ๋ช…์„ธ์„œ ํ™•์ธ์„ ์œ„ํ•œ ์ž„์‹œ ๋งํฌ

๐Ÿ’ก ๊ธฐํƒ€์‚ฌํ•ญ

  • Controller ํ…Œ์ŠคํŠธ ์ฝ”๋“œ๊ฐ€ ์ „์ฒด์ ์ธ ๊ฐœ์„  ํ•„์š”
    • AvatarImage, Weather, Post, Like ๋„๋ฉ”์ธ์— ํ•ด๋‹นํ•˜๋Š” Controller์—์„œ Response body์— ๋Œ€ํ•œ ํ…Œ์ŠคํŠธ ์ฝ”๋“œ ์ถ”๊ฐ€๊ฐ€ ํ•„์š”
    • AvatarImageController์—์„œ mocking์ด ์—†์ด ๋ฐ”๋กœ status๋ฅผ ํ™•์ธํ•˜๋Š” ํ…Œ์ŠคํŠธ๊ฐ€ ์กด์žฌ, ์ถ”ํ›„ ์ˆ˜์ • ํ•„์š”
    • LikeController์—์„œ response๋ฅผ ํ™•์ธํ•˜๋Š” ํ…Œ์ŠคํŠธ๊ฐ€ ํ•„์š”
    • Post์™€ ๊ฐ™์€ ๋„๋ฉ”์ธ์€ ์ƒ์„ฑ์ž๊ฐ€ ๋ง‰ํ˜€์žˆ๊ณ  DTO๋ฅผ ํ†ตํ•œ ์ƒ์„ฑ๋งŒ ๊ฐ€๋Šฅํ•˜๊ธฐ ๋•Œ๋ฌธ์— ํ…Œ์ŠคํŠธ ์šฉ์ด์„ฑ์— ์–ด๋ ค์›€์ด ์žˆ์Œ, ์ถ”ํ›„ ๋…ผ์˜ ํ•„์š”

ASak1104 added 29 commits January 18, 2024 03:19
@ASak1104
test: ํ•„์š”์—†๋Š” ๋ฉ”์„œ๋“œ ์ œ๊ฑฐ
0c518f8
@ASak1104
chore: restdocs gradle task ์„ค์ •
3d5b136
@ASak1104
test: user document test ์ถ”๊ฐ€
1113539
@ASak1104
docs: restdocs index ํŒŒ์ผ ์ถ”๊ฐ€
f2e093d
@ASak1104
test: certificate document test ์ถ”๊ฐ€
9d83e22
@ASak1104
docs: certificate api docs ์ถ”๊ฐ€
4a128c4
@ASak1104
test: avatar image documentation test ์ถ”๊ฐ€
0fc9844
@ASak1104
docs: avatar image api docs ์ถ”๊ฐ€
e28b5bb
@ASak1104
test: avatar image upload test์— token ์„ค์ • ์ถ”๊ฐ€
1d3d463
@ASak1104
docs: avatar image upload header ์ถ”๊ฐ€
3607561
@ASak1104
style: fix typo
29c0afd
@ASak1104
style: ์‚ฌ์šฉํ•˜์ง€ ์•Š๋Š” import ๋ฌธ ์ œ๊ฑฐ
bc95393
@ASak1104
test: post like documentation test ์ถ”๊ฐ€
a20d575
@ASak1104
docs: post like api docs ์ถ”๊ฐ€
4241470
@ASak1104
test: weather documentation test ์ถ”๊ฐ€
87248d8
@ASak1104
docs: weather api docs ์ถ”๊ฐ€
d23d850
@ASak1104
style: rename weather documentation test class
bc378e7
@ASak1104
test: post create documentation test ์ถ”๊ฐ€
90bf6e8
@ASak1104
test: post read detail documentation test ์ถ”๊ฐ€
37bfa28
@ASak1104
test: post read all documentation test ์ถ”๊ฐ€
895ca93
@ASak1104
test: post update documentation test ์ถ”๊ฐ€
35e65bf
@ASak1104
test: post delete documentation test ์ถ”๊ฐ€
f248e0e
@ASak1104
docs: post create api docs ์ถ”๊ฐ€
3d7b012
@ASak1104
docs: post read detail api docs ์ถ”๊ฐ€
c659ea9
@ASak1104
docs: post read all api docs ์ถ”๊ฐ€
be5e6b6
@ASak1104
test: ๋ˆ„๋ฝ๋œ update request ํ•„๋“œ ์ถ”๊ฐ€
c246a26 
+ faker book title์ด 30์ž๋ฅผ ์ดˆ๊ณผํ•ด์„œ ์‹คํŒจํ•˜๋Š” ์˜ค๋ฅ˜ ์ˆ˜์ •
@ASak1104
docs: post update api docs ์ถ”๊ฐ€
149db1e
@ASak1104
docs: post delete documentation test ์ถ”๊ฐ€
377b8b0
@ASak1104
docs: ootw api document index ํŒŒ์ผ
6a33828
@ASak1104 ASak1104 added the enhancement New feature or request label Jan 17, 2024
@ASak1104 ASak1104 self-assigned this Jan 17, 2024
@github-actions GitHub Actions
Copy link

๐Ÿ“‘ Jacoco ํ…Œ์ŠคํŠธ ๊ฒฐ๊ณผ

Overall Project 98.48% ๐Ÿ
File Coverage
LikeController.java 100% ๐Ÿ

@ASak1104 ASak1104 linked an issue Jan 17, 2024 that may be closed by this pull request
โœ… #OOTW Server API Restdocs ๋ช…์„ธ์„œ ์ถ”๊ฐ€ #74
Closed
7 tasks
Sehee-Lee-01
Sehee-Lee-01 approved these changes Jan 18, 2024
View reviewed changes
Copy link
Member

@Sehee-Lee-01 Sehee-Lee-01 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

๋„๋ฉ”์ธ ํด๋ž˜์Šค(Post)๋ฅผ ์ •์˜ํ•  ๋•Œ ๋ถˆํ•„์š”ํ•œ ๋ฉ”์„œ๋“œ ๋…ธ์ถœ์„ ์ค„์ด๋ ค๊ณ  ์ƒ์„ฑ์ž๋ฅผ ์ œํ•œ ์‹œ์ผฐ๋Š”๋ฐ ์˜คํžˆ๋ ค ์กฐ๊ธˆ ๋ถˆํŽธํ•œ ์ƒํ™ฉ์ด ์ƒ๊ธฐ๋Š” ๊ฒƒ ๊ฐ™๊ธฐ๋„ ํ•˜๋„ค์š”,,,ใ… ใ… 
์ž‘์„ฑํ•˜์‹œ๋Š๋ผ ๋„ˆ๋ฌด ๋„ˆ๋ฌด ๊ณ ์ƒ ๋งŽ์œผ์…จ์Šต๋‹ˆ๋‹ค!

src/docs/asciidoc/index.adoc Outdated Show resolved Hide resolved
@github-actions GitHub Actions
Copy link

๐Ÿ“‘ Jacoco ํ…Œ์ŠคํŠธ ๊ฒฐ๊ณผ

Overall Project 98.48% ๐Ÿ
File Coverage
LikeController.java 100% ๐Ÿ

shoeone96
shoeone96 approved these changes Jan 18, 2024
View reviewed changes
Copy link
Collaborator

@shoeone96 shoeone96 left a comment

Choose a reason for hiding this comment

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

RestDocs ์ž‘์—… ๊ณ ์ƒํ•˜์…จ์–ด์š”!

@github-actions GitHub Actions
Copy link

๐Ÿ“‘ Jacoco ํ…Œ์ŠคํŠธ ๊ฒฐ๊ณผ

Overall Project 98.48% ๐Ÿ
File Coverage
LikeController.java 100% ๐Ÿ

@ASak1104 ASak1104 merged commit 09ffbcc into feature Jan 18, 2024
1 check passed
@ASak1104 ASak1104 deleted the feature-restdocs branch January 18, 2024 10:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Sehee-Lee-01 Sehee-Lee-01 Sehee-Lee-01 approved these changes

@shoeone96 shoeone96 shoeone96 approved these changes

Assignees

@ASak1104 ASak1104

Labels
enhancement New feature or request
Projects
outfit-of-the-weather
Status: Done
Milestone
Should Have ์„œ๋น„์Šค ๊ตฌํ˜„
Development

Successfully merging this pull request may close these issues.

โœ… #OOTW Server API Restdocs ๋ช…์„ธ์„œ ์ถ”๊ฐ€
3 participants
@ASak1104 @shoeone96 @Sehee-Lee-01