Pre-Project(학습 : 설계 - 사용자 요구사항 정의서/화면 정의서/ API 명세서)

사용자 요구사항 정의서

• 요구사항 ID
• 요구사항명
• 구분(기능/성능/품질/인터페이스/데이터/운영/제약사항 중 선택 기제)
• 요구사항 설명(상세)
• 중요도(상, 중, 하)
• 비고

화면 정의서

• 화면 ID
• 화면명
• 화면 유형(입력/출력)
• 메뉴 경로(또는 이동경로)
• 화면 개요(간단한 설명)
• 화면 미리보기(설계 툴을 사용한 이미지에 기능 수행 항목에 번호를 매겨 표시)
• 기능 번호
• 요구사항 아이디
• API 활용 여부
• API 주소
• 유효성 체크(기능 동작을 위한 필수 데이터)

테이블 명세서

테이블과 인덱스를 데이터베이스에 맵핑
데이터베이스 목록을 작성하고, 데이터베이스의 물리적 상세내용을 기술

• 데이터베이스명
• 테이블 명
• 요구사항 ID(매핑)
• 테이블 설명(목적 및 역할을 간략하게 기술
• 열 이름
• 열 ID
• 타입 및 길이(열의 타입, 최대 허용 길이)
• NOT NUll(필수 항목 여부)
• PK(primary Key)
• FK(Foreign Key)
• INX(Index)
• 기본값(있는 경우 기술)
• 제약조건(있는 경우 기술)

API 명세서

RESTful한 API를 정의하고 구현, 모든 리소스에 대해 고유한 URI를 부여
HTTP Method 사용을 통한 리소스 제어의 수단이 된다

기본 URI구조

scheme:[//``[user[:password]@host[:port]]``[/path]``[?query]``[#fragment]
scheme : http https
user, password : ID와 PASSWORD
host, port : 서버의 호스트와 포트 번호
path : 서버의 상세 경로
query : 파라미터
fragment : 메인 리소스 내에 존재하는 서브 리소스에 접근할 때 식별하기 위한 정보

REST API 규칙

http://test.com/groups/1/users
groups, users : 복수 리소스,‘Collection’
1 : Collection에 포함된 대상 리소스‘Document’
/groups/1/users : Collection과 Document의 관계를 /를 통해 표현

HTTP Method

GET : SELECT
POST : INSERT
PUT : UPDATE