RESTful 2

RESTful API 개념과 특징, 설계 시 중요한 점 (Representational State Transfer)

RESTful API (Representational State Transfer) 란, REST API는 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용한 웹의 장점을 최대한 활용한 아키텍쳐 스타일입니다. 자원의 이름 (자원의 표현) 으로 구분하여 해당 자원의 상태 (정보) 를 주고받는 모든 것을 의미하며, 조금 더 자세하게는 HTTP URI로 자원을 표현하고, Method (GET, POST, PUT, PATCH, DELETE)를 통해 자원에 대한 처리를 합니다. RESTful API는 Resource (자원) + Method (행위) + Representation of Resource (자원의 형태) 세 가지로 구성됩니다. Resource : 서버는 Unique 한 ID를 가지는 Resource를 ..

Programming/Web 2021.08.10

Swagger 사용하여 RESTful API 문서 자동화하기 (SpringBoot)

처음에는 회사에 들어갔을 때는 Swagger를 잘 만들어야 한다는 이야기가 크게 와닿지 않았는데, 프로젝트를 진행하며 협업에 있어서 내가 개발한 것을 다른 사람들도 쉽게 알아보고, 사용할 수 있도록 문서화하는 것이 중요하구나를 많이 느끼고 있습니다. 그래서 Web API 문서화 도구 중 많이 쓰이는, 그리고 사용하고 있는 Swagger의 사용법에 대해 정리해보려고 합니다. (Swagger 외에는 많이 사용되는 문서화 도구는 SpringRestDocs가 있습니다.) Swagger란 무엇일까? 백엔드 개발에 있어서 Web API를 문서화하기 위한 도구이며 쉽게는 제품의 설명서라고도 생각할 수 있습니다. 간단한 설정으로 프로젝트의 API 목록을 웹에서 확인 및 테스트 가능하게 하는 라이브러리이며, 특히 RES..