YC Tech Academy
[YC Tech Academy] 1주차 복습
2twix2
2023. 9. 12. 01:40
1. REST API 설계
- REST는 Representational State Transfer의 약자로, 2000년에 Roy Fielding에 의해 만들어진 소프트웨어 아키텍처 스타일로, 웹 아키텍처의 설계를 안내하기 위해 고안되었다. REST 원칙을 따르는 모든 API는 RESTful하다고 말한다.
- RESTful하게 API 설계하기
- 데이터 송수신 형식으로 JSON 사용
- 엔드포인트에서 동사 대신 명사 사용
- 복수형 명사로 컬렉션 명명
- 오류 처리에 HTTP 상태 코드 사용
- 관계를 나타내기 위해 엔드포인트 중첩 사용
- 요청한 데이터를 검색하기 위해 필터링, 정렬 및 페이지네이션 사용
- 보안을 위해 SSL 사용
- 버전을 명확하게 표시
- 정확한 API 문서 제공
2. Controller 작성 & 설계
- @RestController = @Controller + @ResponseBody