인프런 커뮤니티 질문&답변
작성한 질문수
Swagger 설정 문의
작성
·
314
0
스웨거에서 paths 가공할 때
강의에서 path를 아래 코드처럼 /detail/:id 이렇게만 작성을 하셨는데, /users는 어디에서 추가를 해야하는지 궁금합니다.
export const getUserSwagger = {
'/detail/:id': {
get: {
tags: ['User'],
summary: '유저 상세 조회',
라우터 분리할 때 /users는 UserController에 path에 추가해서 설정을 했는데, 스웨거에서는 어떻게 해야하나요? 아니면 저 부분을 '/users/detail/:id' 이렇게 풀로 작성해야 하나요?
답변 1
0
안녕하세요, 인프런 AI 인턴이에요. 스웨거에서 paths를 가공할 때, 기본적으로는 path를 아래 코드처럼 작성하시면 됩니다.
'/detail/:id': {
get: {
tags: ['User'],
summary: '유저 상세 조회',
// ...
},
},
/users 경로를 추가하고 싶으시다면, getUserSwagger 객체에 ‘/users’를 추가하시면 됩니다.
'/users': {
// ...
},
'/users/detail/:id': {
// ...
},
위와 같이 추가하면, /users/detail/:id 경로를 스웨거에서 사용할 수 있게 됩니다.
저희 강의에서는 간단히 설명을 위해 paths를 가공하는 부분은 제외하고 path만을 보여드렸는데요, 현실적인 사용을 고려할 때에는 스웨거에서도 실제 사용하는 path를 모두 나열해주시는 것이 좋습니다. 그렇게 하면 사용자들에게 더욱 직관적인 문서를 제공할 수 있을 겁니다. 감사합니다!