Rinjae
62 lines
3.0 KiB
Markdown
62 lines
3.0 KiB
Markdown
# API 그룹 관리 가이드
|
||
API 그룹 관리를 통해 개발자들이 쉽게 API를 찾고 이해할 수 있도록 도와줍니다. 이 가이드에서는 API 그룹을 효과적으로 관리하는 방법을 알려드립니다.
|
||
|
||
## 📁 API 그룹 관리 시작하기
|
||
|
||
1. 관리자 포털에 로그인합니다.
|
||
2. 메뉴에서 **거래관리 > API > API 그룹 관리**로 이동합니다.
|
||
|
||
## 🔍 API 그룹 살펴보기
|
||
|
||
|
||
|
||
- 등록된 API 그룹들을 한눈에 볼 수 있습니다.
|
||
- 각 그룹의 이름, 설명, 공개 여부 등을 확인할 수 있습니다.
|
||
- '신규' 버튼으로 새 그룹을 만들거나 '검색'으로 특정 그룹을 찾을 수 있습니다.
|
||
|
||
## ➕ 새 API 그룹 만들기
|
||
|
||
|
||
|
||
1. '신규' 버튼을 클릭합니다.
|
||
2. 다음 정보를 입력합니다:
|
||
- **API 그룹 명** (필수): 개발자들이 쉽게 이해할 수 있는 이름을 지어주세요.
|
||
- **컨텐츠 제목**: 개발자 포털 목록에 표시될 제목입니다.
|
||
- **메인 문구**: 개발자 포털 목록에서 그룹을 간단히 설명하는 문구입니다.
|
||
- **공개 여부**: 개발자들에게 공개할지 결정합니다.
|
||
- **표시 순서**: 개발자 포털에서의 표시 순서를 정합니다.
|
||
- **메인 아이콘**: 그룹을 대표하는 이미지를 선택합니다.
|
||
- **컨텐츠 내용**: 개발자 포털 상세 페이지에 표시될 상세 설명을 작성합니다.
|
||
3. 그룹에 포함할 API를 '+ 추가' 버튼으로 선택합니다.
|
||
4. '저장' 버튼을 눌러 완료합니다.
|
||
|
||
## 🔄 API 그룹 수정하기
|
||
|
||
|
||
|
||
1. 수정할 그룹을 목록에서 선택합니다.
|
||
2. 필요한 정보를 변경합니다.
|
||
3. API 추가나 제거가 필요하면 그룹 대상 API 섹션을 수정합니다.
|
||
4. '저장' 버튼을 눌러 변경사항을 적용합니다.
|
||
|
||
## 🚀 개발자 포털에서 확인하기
|
||
|
||
관리자가 만들고 수정한 API 그룹은 개발자 포털에 다음과 같이 나타납니다:
|
||
|
||
### 📱 API 서비스 메인 페이지
|
||
|
||
메인메뉴에서 **API 서비스**를 클릭하여 이동합니다.
|
||
|
||
|
||
|
||
- 관리자가 입력한 **컨텐츠 제목**과 **메인 문구**가 여기에 표시됩니다.
|
||
- 선택한 메인 아이콘도 함께 보입니다.
|
||
- 개발자들은 이 페이지에서 API 그룹을 쉽게 찾을 수 있습니다.
|
||
|
||
### 📄 API 그룹 상세 페이지
|
||
|
||
|
||
|
||
- **컨텐츠 제목**, **메인 문구**, 그리고 **컨텐츠 내용**이 모두 이 페이지에 표시됩니다.
|
||
- 그룹에 포함된 API 목록도 여기서 확인할 수 있습니다.
|