GDSC web - DB 및 REST API 설계

GDSC 시리즈

• Google Developer Students Club Seoultech - 2기(22년 하반기 ~ 23년 상반기) >web 파트 코어 멤버로서 활동했던 내용들에 대하여 정리해둔 시리즈 입니다.

• 주요 항목
  • web 파트 커리큘럼 발표 내용 (Spring을 활용하여 CRUD 게시글 프로젝트 제작)
  • 세미나 발표 내용 (AWS, ...)
  • Solution Challenge 프로젝트

GDSC web 커리큘럼

주제 : React 와 Spring 을 활용하여 개인 블로그 웹 사이트를 개발합니다.
대상 : GDSC web 파트 멤버 (기본적인 Java, javascript 문법을 다룰 수 있는 정도.)
목표 : 웹 개발시 필수적으로 사용되는 CRUD에 대하여 학습하며, 프론트 와 백에 대한 학습을 통하여 웹 개발의 기본적인 흐름을 이해할 수 있습니다.

커리큘럼

1차시 : DB 및 REST API 설계

카드뉴스

DataBase 설계 (ERD)

• ERD(Entity Relationship Diagram)
  • 테이블간의 관계를 설명해주는 다이어그램 입니다.
  • 프로젝트에서 사용되는 DB 의 구조를 한눈에 파악할 수 있습니다.

위 사진은 ERD 예시 입니다. 각 사각형은 객체 즉 Entity를 뜻합니다.
해당 Entity 에는 기본키, 외래키, 속성, 제약조건 등과 같은 다양한 사항들을 표시할 수 있습니다.

또한 위 사진과 같은 표시를 통하여 다양한 객체들 간의 관계를 표시해줍니다.

• 위 ERD 의 Post 와 Category 의 관계는 하나의 Category 에 다수의 Post 가 작성 될 수 있는 일대다(OneToMany)의 관계임을 알 수 있습니다.

REST API 설계

• REST API

  • REST 란 HTTP URI를 통해 자원을 표시하고, HTTP 메서드를 통해 해당 자원에 대한 CRUD 연산을 적용하는 것 을 의미합니다.

  • REST API 란 REST 기반으로 서비스 API를 구현한 것 입니다.
    사람이 읽을 수 있다는 특징이 있습니다.

• CRUD 연산

  • 기본적인 데이터 처리 기능인 Create(생성), Read(읽기), Update(수정), Delete(삭제) 입니다.

• HTTP Method

  • 클라이언트가 웹 서버에게 사용자 요청의 목적이나 종류를 알리는 수단 입니다.
  • GET, POST, PUT, DELETE 가 대표적입니다.

• GET

  • 서버에 존재하는 데이터를 요청하는 것 입니다. CRUD로 따지면 Read에 해당 합니다.

• POST

  • 서버에 데이터 생성을 요청하는 것 입니다. CRUD로 따지면 Create에 해당합니다.

• PUT

  • 서버에 존재하는 데이터를 수정하는 요청입니다. CRUD로 따지면 Update에 해당합니다.

• DELETE

  • 서버에 존재하는 데이터를 삭제하는 요청입니다. CRUD로 따지면 Delete에 해당합니다.

• REST API 테스트 도구

  • Postman (application)
    

  • Talend API Tester (크롬 확장 도구)
    

• Swagger 문서

  • Swagger 는 REST API를 설계, 빌드, 문서화 해주는 도구 입니다.