티스토리

_yunilog
검색하기

블로그 홈

_yunilog

jungdo8016.tistory.com/m

_DoYun 님의 블로그입니다.

구독자
0
방명록 방문하기

주요 글 목록

  • [자바 Spring] intellij로 복잡한 API문서를 자동으로 만들 수 있다고!? Spring Rest Docs에 대해 배워보자 API 문서란 개발자가 제작한 애플리케이션을 효과적으로 사용하기 위해 클라이언트(웹 브라우저)에게 제공하는 애플리케이션 사용법 문서입니다. 위 API 예시처럼 애플리케이션에서 꼭 필요한 각 필드들의 TYPE과 용도,필요성 등이 기입되게 됩니다. 일반적으로 API 문서는 개발자가 직접 작성하지만 Spring은 편리성을 위해 자동으로 API 문서 제작이 가능한 기능을 넣어두었습니다. 대표적으로 "Spring Rest Doc"와 "Sweggar"이 있습니다. 아래 코드는 Swagger 활용 예시입니다. 다른 코드는 다 필요없이 @Api가 들어간 에노테이션들만 보시면 됩니다. 보시다시피 거의 모든 메서드에 특정 에노테이션이 추가되어 있습니다. 비록 Swagger가 "postman"과 같이 Api 요청 툴로써 활.. 공감수 0 댓글수 0 2022. 7. 21.
    문의안내
    • 티스토리
    • 로그인
    • 고객센터

    티스토리는 카카오에서 사랑을 담아 만듭니다.

    © Kakao Corp.