인프런 커뮤니티 질문&답변
작성한 질문수
스웨거 query parameter 전달 방법
작성
·
287
0
아무리 찾아도 나오질 않아서 여기에 글 남깁니다.
스웨거 ui 에 파라미터 전달 방법에
page
integer($int64)
(query)
이렇게 정의되어 있는건 이해가 되는데
cond[addr::LIKE]
string($string)
(query)
이렇게 정의되어 있는건 query parameter를 어떤식으로 전달을 해야 하는가요?
답변 1
0
안녕하세요, 인프런 AI 인턴입니다.
장성호님, 스웨거 UI에서 cond[addr::LIKE] 같은 형식의 쿼리 파라미터는 특정한 검색 조건이나 필터를 사용자가 정의하여 전달할 때 사용됩니다. 이 경우 cond는 조건을 나타내는 파라미터 명이고, addr는 필터를 적용할 필드명, LIKE는 SQL의 LIKE와 유사한 검색 방식을 의미합니다.
쿼리 파라미터를 전달할 때는 URL에 해당 조건을 포함하여 요청을 보내게 됩니다. 예를 들어, 주소에 “서울”이 포함된 결과를 가져오고 싶은 경우, 요청하는 URL은 다음과 같을 수 있습니다.
http://example.com/api/resource?cond[addr::LIKE]=서울
이렇게 URL에 파라미터를 직접 추가하여 요청을 보냅니다. % 기호를 사용하여 부분일치 검색도 가능하며, 이는 기존의 SQL 쿼리와 유사한 패턴을 따릅니다. 그러나 특정 구현이나 API 문서에 따라 정확한 방식이 달라질 수 있으므로 해당 웹 서비스의 API 문서를 참고하시는 것이 중요합니다.
Spring Boot 개발에 관련된 더 구체적인 문서 정보가 필요하시면 Spring Boot Reference Documentation을 참고하시는 것을 추천드립니다. “18. ‘How-to’ Guides” 섹션에서는 Spring Boot 사용 시 자주 발생하는 질문에 대해 다루고 있으나 스웨거 UI의 쿼리 파라미터 전달 방법에 대한 구체적인 언급은 없습니다.
백엔드 API 개발과 관련하여 더 깊이있는 정보를 원하신다면 다음 문서를 살펴보시기 바랍니다.
- Spring Boot Reference Documentation: https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/#using
- Stack Overflow의 spring-boot 태그를 이용하여 추가적인 질문을 하고 답변을 얻을 수 있습니다: https://stackoverflow.com/tags/spring-boot
이 문서들이 귀하의 질문에 답변이 되길 바랍니다.