📄 기능 명세서 (Function Specification Sheet)

✅ 테이블

기능 ID 기능명 설명 연관 UC HTTP 메서드 요청 URL 입력값 출력값 처리 흐름
F-001 회원가입 사용자가 이메일, 비밀번호, 닉네임을 입력하여 회원으로 등록한다. UC-1-002 (회원가입) POST /api/signup {
email,
pw,
pwCheck,
nickname
} 성공 시 메시지 / 실패 시 에러 메시지 클라이언트에서 가입 폼 작성
F-002 로그인 사용자가 아이디와 비밀번호를 입력하여 인증을 진행하고 세션을 생성한다. UC-2-001(로그인) POST /api/member/login {
email,
pw
} 로그인 성공 여부 및 리다이렉션 URL 사용자가 로그인 페이지에서 입력
F-003 기업 등록 인증된 사용자가 기업 정보를 적어 등록을 한다. UC-2-002 (기업정보 작성) POST /api/companies/new {
name,
companyImage,industry,
location,
website,
description
} 성공 시 메시지 / 실패 시 에러 메시지 사용자 입력 값 검증
F-004 기업 조회
(메인 페이지) 정보가 작성된 기업들을 조회한다. UC-1-001 (작성된 기업들 조회) GET /api/companies - 기업 리스트 객체(JSON 데이터) 사용자가 홈 화면을 클릭
F-005 기업 상세 조회 특정 기업의 상세 정보를 조회한다. UC-2-003 (특정 기업 조회) GET /api/companies/{companyId} 기업 번호 (PathVariable) 기업 디테일 객체(JSON 데이터) 사용자가 리스트에서 기업 클릭
F-006 기업 수정
(분석) 특정 기업의 분석 내역을 수정한다. UC-2-004 (기업 분석내역 수정) PUT /api/companies/{companyId}/detail/{detailId} {
”title”,
”content”
} 업데이트 성공 시 메시지 / 실패 시 에러 메시지 작성자가 분석조회에서 수정 버튼 클릭
F-007 기업 수정
(후기) 특정 기업의 후기 내역을 수정한다. UC-2-004 (기업 후기내역 수정) PUT /api/companies/{companyId}/review/{reviewId} {
”title”,
”position”,
”stage”,
“result”,
”content”
} 업데이트 성공 시 메시지 / 실패 시 에러 메시지 작성자가 후기조회에서 수정 버튼 클릭
F-008 기업 분석 삭제
특정 기업의 분석 내역을 삭제한다. UC-2-005 (기업 분석내역 삭제) DELETE /api/companies/{companyId}/detail/{detailId} - 삭제 완료 메시지/ 오류 메시지 작성자가 분석조회에서 삭제 버튼 클릭
F-009 기업 후기 삭제
특정 기업의 후기 내역을 삭제한다. UC-2-005 (기업 후기내역 삭제) DELETE /api/companies/{companyId}/review/{reviewId} - 삭제 완료 메시지/ 오류 메시지 작성자가 후기조회에서 삭제 버튼 클릭
F-010 기업 분석 작성 사용자가 기업 분석을 페이지에 작성한다. UC-2-002(기업 분석 작성) POST /api/companies/{companyId}/detail {
”title”,
”content”
} 성공 시 메시지 / 실패 시 에러 메시지 사용자 입력 값 검증
F-011 기업 후기 작성 사용자가 기업 후기를 페이지에 작성한다. UC-2-002 (기업 후기 작성) POST /api/companies/{companyId}/review {
”title”,
”position”,
”stage”,
“result”,
”content”
} 성공 시 메시지 / 실패 시 에러 메시지 사용자 입력 값 검증

✅ 기능 명세서 목록

✅ 회원가입

기능 ID F-001
기능명 회원가입
설명 사용자가 이메일, 비밀번호, 닉네임을 입력하여 회원으로 등록한다.
연관 UC UC-1-002 (회원가입)
HTTP 메서드 POST
요청 URL /api/signup
입력값 {
email,
pw,
pwCheck,
nickname
}
출력값 성공 시 메시지 / 실패 시 에러 메시지

처리 흐름

  1. 클라이언트에서 가입 폼 작성
  2. 서버에 POST 요청 전송
  3. 중복 확인 및 입력값 검증
  4. 비밀번호 암호화
  5. DB에 저장
  6. 성공 시 로그인 페이지로 이동 또는 성공 메시지 반환

✅ 로그인

기능 ID F-002
기능명 로그인
설명 사용자가 아이디와 비밀번호를 입력하여 인증을 진행하고 세션을 생성한다.
연관 UC UC-2-001(로그인)
HTTP 메서드 POST
요청 URL /api/member/login
입력값 {
email,
pw
}
출력값 로그인 성공 여부 및 리다이렉션 URL