프로젝트 설계

화면 정의서

시스템이 제공하는 사용자 인터페이스의 전체 구조와 메뉴 형식, 화면 목록과 화면의 상세 설계 내역을 기술한다.

1. 전체 시스템에 대한 인터페이스 구조를 메뉴 형식으로 기술한다.
2. 화면 및 출력을 구분하여 목록으로 작성한다.
3. 화면별로 상세 설계 내용을 기술한다.

 

테이블 명세서

최종적으로 설계된 테이블과 인덱스를 데이터베이스 공간에 매핑시키고 저장 공간 등의 물리 모델을 기술한다.

1. 부서에서 운영하는 데이터베이스 목록 작성한다.
2. 데이터베이스의 물리적 상세 내용을 기술한다.

 

REST API

(Representational State Transfer - Application Programming Interface)

모든 리소스에 대해 고유한 URI를 부여하고 HTTP Method를 사용하여 리소스를 제어할 수 있는 수단을 말한다.

 

URI 구조

scheme:[//[user[:password]@host[:port]][/path][?query][#fragment]

• scheme : http 또는 https
• user, password : 리소스에 접근하기 위해 필요한 ID, PW
• host, port : 서버의 호스트, 포트 번호
• path : 서버의 상세 경로
• query : path에 접근하기 위한 추가 정보(파라미터)
• fragment : 서브 리소스에 접근할 때 식별하기 위한 정보

 

REST 특징

• 서버 클라이언트 구조(Server-Client Architecture)
• 무상태성(Stateless)
• 캐시 가능(Cacheable)
• 일관된 인터페이스(Uniform Interface)
• 자체적인 표현 구조(Self-Descriptiveness)
• 계층 구조(Layered System)

 

REST API 규칙

• /로 끝나면 안된다.
• _말고 -를 사용한다.
• 소문자를 사용한다.
• 동사의 사용을 피한다.
• 파일 확장자를 나타내지 않는다.

 

관계 나타내기

http://test.com/groups/1/users

• groups, users : 복수로 표현되는 것들은 여러 개의 리소스를 가질 수 있기 때문에, 복수형으로 표시하고 Collection이라고 부른다.
• 1 : Collection에 포함된 대상 리소스는 단수형으로 표시하고 Document라고 부른다.
• /groups/1/users : groups라는 Collection 안에 1이라는 Document를 나타내고, 해당 Document가 갖고 있는 users를 나타낸다.

 

HTTP Method

예시	GET	POST	PUT	DELETE
/users	사용자 전체 조회	신규 사용자 등록	실행 불가 (405 Method Not Allowed)	사용자 전체 삭제
/users/1	1의 사용자 조회	실행 불가 (405 Method Not Allowed)	1의 사용자 수정	1의 사용자 삭제

• GET : Query의 SELECT에 해당
• POST : Query의 INSERT에 해당
• PUT : Query의 UPDATE에 해당
• DELETE : Query의 DELETE에 해당