#135.8 rooms API에 swagger 적용

[chlehdwon]

Summary

It closes #135

Extra info

rooms.js를 swagger을 사용하여 문서화합니다.

Images or Screenshots

Further Work

• express-validator 대신 ajv만으로 validation하도록 schema 전체 변경

[chlehdwon]

room.js에서 같은 room object여도 format 되는 형태가 각각 다른데(ex: isOver), 이에 대해서 schema를 별도로 구현하지는 않은 상태입니다. 약간 번거로워 보이긴 하는데 필요하다면 수정 사항과 함께 추후 적용하겠습니다~!

[withSang]

좋아보입니다!! 고생하셨어요..

[withSang]

room.js에서 같은 room object여도 format 되는 형태가 각각 다른데(ex: isOver), 이에 대해서 schema를 별도로 구현하지는 않은 상태입니다. 약간 번거로워 보이긴 하는데 필요하다면 수정 사항과 함께 추후 적용하겠습니다~!

미래엔 프론트엔드에서 swagger 스펙으로부터 바로 type을 생성하게 될 수도 있어서, 저는 지금 맞추고 가면 좋을 것이라고 생각합니다!

[14KGun]

수고하셨습니다 👍

[kmc7468]

수고하셨습니다!! 이번에 같이 #441 이슈가 해결되어도 괜찮을 것 같은데, 다른 PR에서 진행하실 생각이신가요?

[chlehdwon]

@kmc7468 #441 이슈 안 그래도 제가 맡으려고 했는데 validate 관련이면 제 다음 task랑 더 관련이 있을 것 같아요~! 그래서 상님 comment까지만 해결하고 이 PR은 끝내고, 다음 PR에 같이 반영해서 작업하겠습니다!

[chlehdwon]

room.js에서 같은 room object여도 format 되는 형태가 각각 다른데(ex: isOver), 이에 대해서 schema를 별도로 구현하지는 않은 상태입니다. 약간 번거로워 보이긴 하는데 필요하다면 수정 사항과 함께 추후 적용하겠습니다~!

미래엔 프론트엔드에서 swagger 스펙으로부터 바로 type을 생성하게 될 수도 있어서, 저는 지금 맞추고 가면 좋을 것이라고 생각합니다!

모든 경우에 대해 대응해보려 했는데, getIsOver을 사용하는 경우 어차피 schema를 특정할 수 없더라고요... 그래서 일단 undefined가 될 여지가 있는 필드는 optional로 설정하고, 추후에 front type 정의할 때 문제가 된다면 다시 고민을 해봐야 할 것 같습니다.