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.

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

๐Ÿž[Bug] - ์ง€์›์ž ๋ชฉ๋ก ๋ณด๊ธฐ swagger ์—๋Ÿฌ ์ˆ˜์ • #178

Closed
2 tasks done
letskuku opened this issue Jul 25, 2024 · 0 comments
Assignees
Labels
๐Ÿž BugFix Something isn't working

Comments

@letskuku
Copy link
Member

letskuku commented Jul 25, 2024

๐Ÿž Bug - ์ง€์›์ž ๋ชฉ๋ก ๋ณด๊ธฐ swagger ์—๋Ÿฌ ์ˆ˜์ •

๐Ÿ•ต๏ธโ€โ™€๏ธ Condition


์ง€์›์ž ๋ชฉ๋ก ๋ณด๊ธฐ์— ํ•ด๋‹นํ•˜๋Š” api๋ฅผ swagger์—์„œ ์‹คํ–‰ํ•  ๊ฒฝ์šฐ ์—๋Ÿฌ ๋ฐœ์ƒ

๐Ÿ“ Description


  1. api์˜ parameter๋“ค ์ค‘ required false์ธ ๊ฐ’๋“ค์„ ๋น„์›Œ๋‘˜ ๊ฒฝ์šฐ ์‹ค์ œ๋กœ ์‹คํ–‰๋˜๋Š” url๊ณผ swagger url์— ์ฐจ์ด๊ฐ€ ์žˆ์–ด swagger์—์„œ ์‹คํ–‰ ์‹œ ์—๋Ÿฌ ๋ฐœ์ƒ
  • ์‹ค์ œ url ์˜ˆ์‹œ: /applications?part=&docPass=&finalPass=&applicantName=&pageNum=1&limit=7
  • swagger url ์˜ˆ์‹œ: /applications?pageNum=1&limit=7
  1. api์˜ parameter๋“ค ์ค‘ enum์ธ ๊ฐ’๋“ค์ด ์‹ค์ œ๋กœ ์‹คํ–‰๋˜๋Š” url๊ณผ swagger url์— ์ฐจ์ด๊ฐ€ ์žˆ์–ด swagger์—์„œ ์‹คํ–‰ ์‹œ ์—๋Ÿฌ ๋ฐœ์ƒ
  • ์‹ค์ œ url ์˜ˆ์‹œ: /applications?part=PRODUCT&docPass=PASS&finalPass=FAIL&applicantName=&pageNum=1&limit=7
  • swagger url ์˜ˆ์‹œ: /applications?part=๊ธฐํš&docPass=ํ•ฉ๊ฒฉ&finalPass=๋ถˆํ•ฉ๊ฒฉ&applicantName=&pageNum=1&limit=7

โœ… To Do List


  • required false์ธ parameter๋“ค์— ๋Œ€ํ•ด default value ์„ค์ •
  • enum ํƒ€์ž…์ธ parameter๋“ค์— ๋Œ€ํ•ด allowable values ์„ค์ •
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
๐Ÿž BugFix Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant