SMALL 분류 전체보기38 [Springboot] 7. 스프링에서 REST API 명세를 문서화하는 방법 - Swagger 1. API 명세란? API를 개발하면 명세를 관리해야 합니다. 명세란 해당 API가 어떤 로직을 수행하는지 설명하고 이 로직을 수행하기 위해 어떤값을 요청하며, 이에 따른 응답값은 무엇인지를 정리한 자료입니다. 2. Swaager 사용 이유 API는 개발 과정에서 계속 변경되므로 명세도 주기적으로 업데이트 해야합니다. 하지만 해당 작업은 번거롭고 오래걸립니다. 해당 문제를 해결하기 위해 등장한것이 Swagger 라는 오픈소스 프로젝트입니다. 3. Swagger 설정 3-1. pom.xml 의존성 추가 3-2. /config/SwaggerConfiguration.java 생성 후 설정 - RequestHandlerSelectors.basePackage() 메서드를 사용해 Swagger에서 스캔 할 패키지.. 2023. 2. 8. [Springboot] 6. 스프링에서 API를 작성하는 다양한 방법 - DELETE 각 HTTP 메서드에 해당하는 API를 개발하는 내용을 다룹니다. 1. DELETE API 만들기 DELETE API는 웹 애플리케이션 서버에서 값을 삭제 할 때 사용하는 API입니다. 1-1. @RestController - RestController는 @Controller에 @ReponseBody가 추가된 형태로 RestController의 주용도는 JSON 형태로 객체 데이터를 반환하는것 - 모든 메서드에 @ResponseBody를 추가한것과 동일하다 - 뷰를 반환하지 않는다. 1-2. @RequestMapping - 클라이언트에서 URL로 들어온 요청을 Controller와 매핑 해주는 어노테이션 - 클래스에 선언시에는 모든 메서드앞에 설정한 URL이 추가된다. - 주요 옵션 옵션 설명 value.. 2023. 2. 8. [Springboot] 5. 스프링에서 API를 작성하는 다양한 방법 - PUT 각 HTTP 메서드에 해당하는 API를 개발하는 내용을 다룹니다. 1. PUT API 만들기 PUT API는 웹 애플리케이션 서버에서 값을 수정 할 때 사용하는 API입니다. 1-1. @RestController - RestController는 @Controller에 @ReponseBody가 추가된 형태로 RestController의 주용도는 JSON 형태로 객체 데이터를 반환하는것 - 모든 메서드에 @ResponseBody를 추가한것과 동일하다 - 뷰를 반환하지 않는다. 1-2. @RequestMapping - 클라이언트에서 URL로 들어온 요청을 Controller와 매핑 해주는 어노테이션 - 클래스에 선언시에는 모든 메서드앞에 설정한 URL이 추가된다. - 주요 옵션 옵션 설명 value URL 값.. 2023. 2. 8. [Springboot] 4. 스프링에서 API를 작성하는 다양한 방법 - POST 각 HTTP 메서드에 해당하는 API를 개발하는 내용을 다룹니다. 1. POST API 만들기 POST API는 웹 애플리케이션 서버에 값을 저장 할 때 사용하는 API입니다. 1-1. @RestController - RestController는 @Controller에 @ReponseBody가 추가된 형태로 RestController의 주용도는 JSON 형태로 객체 데이터를 반환하는것 - 모든 메서드에 @ResponseBody를 추가한것과 동일하다 - 뷰를 반환하지 않는다. 1-2. @RequestMapping - 클라이언트에서 URL로 들어온 요청을 Controller와 매핑 해주는 어노테이션 - 클래스에 선언시에는 모든 메서드앞에 설정한 URL이 추가된다. - 주요 옵션 옵션 설명 value URL .. 2023. 2. 8. 이전 1 ··· 4 5 6 7 8 9 10 다음 728x90 반응형 LIST
