○ OPEN API 템플릿 만들기 - API 명세서

 

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

---

목차

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

---

사용자

 

1. 로그인

POST

Login Request

https://api.test.com/login

 

Parameters

변수	타입	설명
id	string	사용자 아이디
password	string	사용자 비밀번호

---

 

401: Unauthorized

{
    "code" : 401,
    "message" : "해당하는 아이디 또는 비밀번호가 존재하지 않습니다."
}

 

 

200: OK

{
    "code" : 200,
    "message" : "로그인이 완료되었습니다."
}

 

 

 

2. 회원가입

POST

SignUp Request

https://api.test.com/signUp

 

Parameters

변수	타입	설명
id	string	사용자 아이디
pasword	string	사용자 비밀번호
password_confirm	string	비밀번호 확인
use_purpose	string	API 사용목적

---

 

400: Bad Request

{
    "code" : 400,
    "message" : "잘못된 요청입니다."
}

 

 

200: OK

{
    "code" : 200,
    "message" : "회원가입이 완료되었습니다."
}

 

 

 

3. OPEN API 이용신청

POST

OPEN API Request - Add OPEN API User

https://api.test.com/openapi/apply

 

Parameters

변수	타입	설명
project_name	string	프로젝트 이름
api_namae	string	API 이름
host	string	호스트

---

 

400: Bad Request

{
    "code" : 400,
    "message" : "잘못된 요청입니다."
}

 

 

200: OK

{
    "code" : 200,
    "message" : "API 이용신청이 완료되었습니다."
}

 

 

 

관리자

 

1. OPEN API 등록

POST

OPEN API Request - Add OPEN API

https://api.test.com/manage/openapi

 

Parameters

변수	타입	설명
name	string	API 이름
domain	string	API 도메인
url[ ]	Array	API 하위 URL 리스트
url[ ].request_type	string	요청 타입
url[ ].request_url	string	요청 URL

---

 

400: Bad Request

{
    "code" : 400,
    "message" : "잘못된 요청입니다."
}

 

 

200: OK

{
    "code" : 200,
    "message" : "API 등록이 완료되었습니다."
}

 

 

 

2. OPEN API 수정

PUT

OPEN API Request - Modify OPEN API

https://api.test.com/manage/openapi

 

Parameters

변수	타입	설명
id	string	API 아이디
name	string	API 이름
domain	string	API 도메인
url[ ]	Array	API 하위 URL 리스트
url[ ].request_type	string	요청 타입
url[ ].request_url	string	요청 URL

---

 

400: Bad Request

{
    "code" : 400,
    "message" : "잘못된 요청입니다."
}

 

 

200: OK

{
    "code" : 200,
    "message" : "API 수정이 완료되었습니다."
}

 

 

 

3. OPEN API 삭제

DELETE

OPEN API Request - Remove OPEN API

https://api.test.com/manage/openapi

 

Parameters

변수	타입	설명
id	string	API 아이디

---

 

400: Bad Request

{
    "code" : 400,
    "message" : "잘못된 요청입니다."
}

 

 

200: OK

{
    "code" : 200,
    "message" : "API 삭제가 완료되었습니다."
}

 

 

 

4. OPEN API 신청내역 조회

GET

OPEN API Request - search OPEN API User List

https://api.test.com/manage/openapi/apply

 

Parameters

변수	타입	설명
pageNo	string	페이지 번호

---

 

404: Not Found

{
    "code" : 404,
    "message" : "데이터를 찾을 수 없습니다."
}

 

 

200: OK

{
    "code" : 200,
    "message" : "신청내역 조회 성공",
    "data" : [
    	{"user_id": "...", "api_name": "...", "api_status": 0},
        {"user_id": "...", "api_name": "...", "api_status": 1},
        {"user_id": "...", "api_name": "...", "api_status": 2}
    ]
}

 

 

 

5. OPEN API 신청내역 승인

PUT

OPEN API Request - approve OPEN API User

https://api.test.com/manage/openapi/apply

 

Parameters

변수	타입	설명
id	string	API 신청내역 아이디

---

 

400: Bad Request

{
    "code" : 400,
    "message" : "잘못된 요청입니다."
}

 

 

200: OK

{
    "code" : 200,
    "message" : "API 신청내역이 승인되었습니다."
}

 

 

 

6. OPEN API 사용내역 

GET

OPEN API Request - search OPEN API User Log

https://api.test.com/manage/openapi/use

 

Parameters

변수	타입	설명
pageNo	string	페이지 번호

---

 

404: Not Found

{
    "code" : 404,
    "message" : "데이터를 찾을 수 없습니다."
}

 

 

200: OK

{
    "code" : 200,
    "message" : "사용내역 조회 성공",
    "data" : [
    	{"user_id": "...", "api_name": "...", "api_call_count": 100},
        {"user_id": "...", "api_name": "...", "api_call_count": 12233},
        {"user_id": "...", "api_name": "...", "api_call_count": 23211}
    ]
}