REST(Representational State Transfer)란? 웹에 존재하는 모든 자원(이미지, 동영상, DB 자원)에 고유한 URI를 부여해 활용 하는것 REST는 분산 시스템 설계를 위한 아키텍처 스타일이다. HTTP URI(Uniform Resource Identifier)를 통해 자원(Resource)을 명시하고, HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation을 적용하는 것을 의미한다. RESTful은 무엇인가? RESTful은 위의 제약 조건의 집합(아키텍처 스타일, 아키텍처 원칙)을 모두 만족하는 것을 의미한다. REST라는 아키텍처 스타일이 있는거고 RESTful API라는 말은 REST 아키텍처 원칙을 모두 만족..
REST
개발 환경 Java(11) Amazon Corretto JDK(11) Spring Boot(2.5.3) jvm.convert(3.3.2) spring-restdocs-asciidoctor spring-restdocs-mockmvc Config 1. Dependency 추가 및 설정 의존성 주입해줄 라이브러리와 플러그인을 추가하고 문서를 생성할 폴더 구조를 설정 plugins { ... // asciidoc파일을 변환해주고, Build폴더에 복사해주는 플러그인 id "org.asciidoctor.jvm.convert" version "3.3.2" ... } ... // ============== BEGIN Spring REST Docs ============== ext { snippetsDir = file..
Spring REST Docs란? 테스트 코드를 기반으로 자동으로 API문서를 자동으로 작성해주는 프레임워크 반드시 Test가 통과되어야 문서가 자동으로 작성되기 때문에 API Spec이 변경되거나 추가/삭제 되는 부분에 대해 항상 테스트 코드를 수정하여야 하며, API 문서가 최신화 될 수 있도록 해준다. 기본적으로 asciidoc을 사용하여 문서를 작성한다. Spring REST Docs Document RESTful services by combining hand-written documentation with auto-generated snippets produced with Spring MVC Test. docs.spring.io Spring REST Docs Architecture Test C..
