[#33] RESTful 방식 + Swagger 사용

REST(Representational State Transfer)

웹 시스템에서 리소스를 정의하고 그 리소스 간의 관계를 HTTP 메서드를 통해 정의하는 아키텍처 스타일

RESTful

REST 아키텍처 원칙을 따르는 시스템 또는 서비스 

RESTful 서비스는 REST의 규칙을 충실히 따르고, HTTP 메서드와 상태 코드를 적절히 활용하여 리소스를 조작

REST API

REST 원칙을 따르는 API로, HTTP 프로토콜을 통해 리소스를 제공하고, 클라이언트가 HTTP 메서드(GET, POST, PUT, DELETE)를 사용하여 데이터를 생성, 읽기, 수정, 삭제할 수 있도록 함

RESTful API

REST 아키텍처 원칙을 잘 따르는 API

 

디자인 가이드

 

---

Swagger

RESTful API를 편리하게 문서화하고 테스트하는 데 사용되는 프레임워크

• pom.xml에 추가

<dependency>
      <groupId>org.springdoc</groupId>
      <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
      <version>2.2.0</version>
</dependency>

• 웹 브라우저로 swagger ui 요청

http://localhost:8080/swagger-ui/index.html