1. ERD 설계 및 API 명세서 작성

HUNI·2023년 12월 23일

ERD 설계

목적

  • DB 스키마 설계를 통한 DB 테이블 정의

    전반적인 개발 과정을 파악과 API 명세서 작성을 준비하기 위한다는 목적만 파악하여 ERD 설계 작업에 들어가자.
    즉, 너무 섬세하게 짤 필요없다. 어차피 본격적인 개발을 시작하면 수정되기 때문.

기대효과

  • DB 스키마 설계를 통한 구체적 프로젝트 정의
  • DB 스키마 설계를 통한 DB 테이블 정의
  • DB 스키마 설계를 통한 API 명세서 작성

DB 스키마를 설계하기 위한 다양한 툴들이 제공된다.(ERDCLOUD, aquerytool, dbdiagrm.io 등등)
ERDCLOUD 를 통해 DB 스키마를 만들어보겠다.

ERD 설계

ERD 설계를 하기 전, 알아야 할 개념들이 있다.

CELEP - ERD 설계본


분석

  1. POST 와 CODY 의 관계
  • POST에 담겨진 전체 착샷은 CODY 테이블에 담겨져 데이터가 관리된다. 다시 말해, POST와 CLOTHES 의 복잡한 관계를 개선하고자 CODY 테이블을 추가했다.

API 명세서 작성

목적

  • 팀원과의 의사소통에 중추적인 역할을 한다.
    : 프론트에서는 API 명세서 기반으로 개발하기 때문에 심혈을 기울여 작성해야 한다.

작업내용

API의 URL, 요청/응답의 형식 및 예시, 메소드(GET, POST, PATCH..), 헤더, 에러 코드, 상태코드 등 다양한 정보를 포함하고 있다.

우리는 구글 스프레드 시트로 미리 API 명세서를 만들었다. API 기능 개발이 완성된 후, SWAGGER로 API 문서화 작업을하였다.


<참고 사이트>
https://velog.io/@jkijki12/3-%ED%94%84%EB%A1%9C%EC%A0%9D%ED%8A%B8-%EC%9D%BC%EB%8C%80%EA%B8%B0-t2u55cpy

profile
어려운 문제에 대해 고민하고 분석하는 과정을 좋아합니다.

0개의 댓글