배경 (Background)

• 프로젝트 목표 (Objective): 서비스 사용자가 여러개의 명함을 등록하고 다른 사용자들끼리 공유하게 함으로써 비즈니스적인 소통을 원활하게 하는것
• 문제 정의 (Problem):
  • 명함의 진위를 판단하기 힘들다

설계 및 기술 자료 (Architecture and Technical Documentation)

<aside> 💡

🤔 이 섹션은 왜 필요한가요?

• 프로젝트를 어떻게 구현할 것인지 구체적인 기술 계획을 담습니다.
• API 명세, 데이터베이스 스키마(ERD), 시스템 구조, 사용 기술 등을 명시하여 개발자들이 참조할 수 있도록 합니다.
• 기술적인 결정과 그 근거를 기록하여 추후 유지보수나 변경 시 참고 자료로 활용됩니다. </aside>

데이터베이스 스키마 (ERD)

• https://www.erdcloud.com/d/WQz8csSSN3qhmBWiE
• 주요 테이블:
  • users: 회원 정보(이름, 이메일, 전화번호, 유선전화 등)
  • card 테이블
• DDL (Data Definition Language):

CREATE TABLE `users` (
	`id`	INT	NOT NULL,
	`account_id`	INT	NOT NULL,
	`name`	VARCHAR(30)	NOT NULL,
	`email`	VARCHAR(255)	NOT NULL	COMMENT 'UK',
	`phone_number`	VARCHAR(15)	NULL,
	`lined_number`	VARCHAR(15)	NULL,
	`company`	VARCHAR(20)	NULL,
	`department`	VARCHAR(20)	NULL,
	`position`	VARCHAR(20)	NULL,
	`profile_image_url`	VARCHAR(2048)	NULL,
	`description`	TEXT	NULL,
	`ai_card_image_url`	VARCHAR(2048)	NULL,
	`created_at`	TIMESTAMP	NOT NULL,
	`updated_at`	TIMESTAMP	NULL,
	`deleted_at`	TIMESTAMP	NULL
);

CREATE TABLE `card` (
	`id`	INT	NOT NULL,
	`user_id`	INT	NULL,
	`uuid`	VARCHAR(36)	NOT NULL	COMMENT 'uuidv7 사용, index',
	`name`	VARHCAR(30)	NOT NULL	COMMENT 'index(email, name)',
	`email`	VARCHAR(255)	NOT NULL,
	`phone_number`	VARCHAR(15)	NULL,
	`lined_number`	VARCHAR(15)	NULL,
	`company`	VARCHAR(20)	NOT NULL,
	`position`	VARCHAR(20)	NULL,
	`department`	VARCHAR(20)	NULL,
	`start_date`	DATE	NOT NULL,
	`end_date`	DATE	NULL,
	`Field`	VARCHAR(255)	NULL,
	`Field2`	VARCHAR(255)	NULL,
	`created_at`	TIMESTAMP	NOT NULL,
	`updated_at`	TIMESTAMP	NULL,
	`deleted_at`	TIMESTAMP	NULL
);

API 명세 (API Specifications)

내 명함 조회 API

• API 명세:
  • GET api/cards/me
• 권한 :
  • 로그인한 사용자
• 구현 상세 :
  • 처리 로직:
    1. JWT에 있는 userId 확인
    2. userId로 card 테이블 조회
    3. created_at, updated_at, deleted_at을 제외하고 json에 담아 응답
    4. data{ cards[..]}