○ OPEN API 템플릿 만들기 - 화면정의서

 

이 포스팅은 Spring Framework 4.x 버전을 이용하였습니다.

---

목차

• 화면정의서
• 유스케이스
• ER Diagram
• API 명세서
• 프로젝트 설계
• 프로젝트 구현

---

화면 정의서

 

1. 로그인 / 회원가입

OPEN API를 이용하기 위해서는 우선 해당 사이트에 회원가입 및 로그인을 해야 합니다.

따라서 아래와 같이 로그인 화면과 회원가입 화면을 정의합니다.

 

 

로그인

 

 

회원가입

 

 

2. 메인페이지 - API 문서

사용할 API에 대한 상세설명이 들어가 있는 문서 페이지를 제공합니다.

 

 

메인페이지 - API 문서

 

 

3. 메인페이지 - API 코드예제

사용할 언어에 따라서 다양한 코드 예시를 제공해줍니다.

 

 

메인페이지 - API 코드예제

 

 

4. 메인페이지 - API 이용신청

OPEN API를 이용하기 위해서는 어떤 아이피 또는 도메인에서 API를 사용할 것인지 등록해야합니다.

각 도메인마다 API 호출 횟수를 제한하기 위해서 입니다.

 

 

메인페이지 - API 이용신청

 

 

5. 관리페이지 - API 등록

관리자로 로그인 하면 보여지는 페이지 안에서 이용할 수 있는 메뉴중 하나입니다.

사용자가 이용할 수 있는 API가 새롭게 개발되었다면, 이 화면을 통해서 사용자가 이용할 수 있도록 API 정보를 등록할 수 있습니다.

 

 

관리페이지 - API 등록

 

 

6. 관리페이지 - API 수정

관리자로 로그인 하면 보여지는 페이지 안에서 이용할 수 있는 메뉴중 하나입니다.

위의 화면에서 API를 등록한 다음, API 정보가 추후에 수정되는 경우에 이 화면을 통해서 수정하실 수 있습니다.

 

 

관리페이지 - API 수정

 

 

7. 관리페이지 - API 신청내역

관리자로 로그인 하면 보여지는 페이지 안에서 이용할 수 있는 메뉴중 하나입니다.

사용자가 API 신청을 하면 승인대기 상태로 아래의 화면에 보여집니다.

관리자가 해당하는 사용자를 체크한 후, 승인 버튼을 눌러주면 그 다음부터 사용자가 API를 이용할 수 있습니다.

 

 

관리페이지 - API 신청내역

 

 

8. 관리페이지 - API 사용내역

관리자로 로그인 하면 보여지는 페이지 안에서 이용할 수 있는 메뉴중 하나입니다.

사용자마다 어떤 API를 얼마나 호출했는지를 볼 수 있습니다.

 

 

관리페이지 - API 사용내역