api 문서 작성 보통 어디에 하시나요?
안녕하세요, 플젝 팀 내부에서 api 문서를 공유하려고 합니다. 어떤 식으로 작성해서 공유할지 고민이 되는데, 라이브러리 공식 문서처럼 남겨야 할지 아님 스웨거나 pdf 문서 정도로 충분할지 선배님들의 의견이 궁금합니다!! (api 문서는 팀 내부에서만 공유하면 됩니다)
기술
#api
#api-doc
#swagger
답변 3
댓글 1
Up 4
조회 1,030
Swagger 사용 관련하여 질문이 있습니다 고수님들
현재 swagger3 사용 중이며 controller에서 @requestbody String xxx 식으로 데이터를 하나만 받으려고 하는데 꼭 dto를 만들어서 @Schema(descriptipn ="블라블라")를 작성해야하나요? dto를 안만들고 description을 넣는 방법은 없을까요? 저렇게 필요한 파라미터가 하나밖에 없을 시에도 꼭 Dto를 만들어서 작성해야하는지 다른 방법은 없는지 궁금합니다.!!
기술
#백엔드
#swagger
#springboot
답변 1
댓글 0
Up 2
조회 169