API 명세서 작성할 때 뷰를 반환하는 controller까지 작성해야하는건가요?

Question

안녕하세요 포트폴리오 제작하면서 API명세서를 작성해보려고하는데요어디까지 API명세서를 작성해야하는지 감이안잡혀서 질문드려봅니다!예를들어 특정 글 조회기능을 API 명세서에 기재할 때, &#64;ResController를 이용하여 ResponseEntity를 반환하는 findArticle메서드와 View에서 사용자에게 글 id를 받아 해당 글의 상세정보를 보여주는 view를 반환하는 getArticle메서드가 있을때 두 메서드 모두 API명세서에 기재해야 하는건가요?아니면 &#64;RestController를 이용하는 findArticle메서드만 기재하면 되는걸까요?

장독깨기 · Accepted Answer

findArticle 은 API, getArticle 은 API 가 아니잖아요. ㅎfindArticle 만 작성하면 되겠습니다. :)

Matthew Kim · Answer

MVC에서 View라면 화면일텐데 API의 리턴으로 표현할 수 있는것은 아닐텐데요. view에서 Object를 json으로 그린다던지 이런식으로 되어 있나요?

API 명세서 작성할 때 뷰를 반환하는 controller까지 작성해야하는건가요?

2개의 답변

기술 목록