Skip to content

Commit

Permalink
GITBOOK-41: 개발자 포털 시작하기 작성 완료
Browse files Browse the repository at this point in the history
  • Loading branch information
Seo-yul authored and gitbook-bot committed Nov 28, 2023
1 parent 8506d7b commit 04af2b3
Show file tree
Hide file tree
Showing 142 changed files with 299 additions and 114 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (1) (1) (1) (1) (1) (1) (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (1) (1) (1) (1) (1) (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (1) (1) (1) (1) (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (1) (1) (1) (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (1) (1) (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (1) (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (10) (1) (1) (1) (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (10) (1) (1) (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (10) (1) (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (10) (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (10).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (11) (1) (1) (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (11) (1) (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (11) (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (11).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (12) (1) (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (12) (1).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified .gitbook/assets/image (12).png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .gitbook/assets/image (13) (1).png
Binary file modified .gitbook/assets/image (13).png
Binary file added .gitbook/assets/image (14) (1).png
Binary file modified .gitbook/assets/image (14).png
Binary file added .gitbook/assets/image (15) (1).png
Binary file modified .gitbook/assets/image (15).png
Binary file added .gitbook/assets/image (16) (1).png
Binary file modified .gitbook/assets/image (16).png
Binary file added .gitbook/assets/image (17) (1).png
Binary file modified .gitbook/assets/image (17).png
Binary file added .gitbook/assets/image (18) (1).png
Binary file modified .gitbook/assets/image (18).png
Binary file added .gitbook/assets/image (19) (1).png
Binary file modified .gitbook/assets/image (19).png
Binary file modified .gitbook/assets/image (2) (1) (1) (1) (1) (1) (1) (1) (1).png
Binary file modified .gitbook/assets/image (2) (1) (1) (1) (1) (1) (1) (1).png
Binary file modified .gitbook/assets/image (2) (1) (1) (1) (1) (1) (1).png
Binary file modified .gitbook/assets/image (2) (1) (1) (1) (1) (1).png
Binary file modified .gitbook/assets/image (2) (1) (1) (1) (1).png
Binary file modified .gitbook/assets/image (2) (1) (1) (1).png
Binary file modified .gitbook/assets/image (2) (1) (1).png
Binary file modified .gitbook/assets/image (2) (1).png
Binary file modified .gitbook/assets/image (2).png
Binary file added .gitbook/assets/image (20) (1).png
Binary file modified .gitbook/assets/image (20).png
Binary file added .gitbook/assets/image (21) (1).png
Binary file modified .gitbook/assets/image (21).png
Binary file added .gitbook/assets/image (22) (1).png
Binary file modified .gitbook/assets/image (22).png
Binary file added .gitbook/assets/image (23) (1).png
Binary file modified .gitbook/assets/image (23).png
Binary file added .gitbook/assets/image (24) (1).png
Binary file modified .gitbook/assets/image (24).png
Binary file added .gitbook/assets/image (25) (1).png
Binary file modified .gitbook/assets/image (25).png
Binary file added .gitbook/assets/image (26) (1).png
Binary file modified .gitbook/assets/image (26).png
Binary file added .gitbook/assets/image (27) (1).png
Binary file modified .gitbook/assets/image (27).png
Binary file added .gitbook/assets/image (28) (1).png
Binary file modified .gitbook/assets/image (28).png
Binary file added .gitbook/assets/image (29) (1).png
Binary file modified .gitbook/assets/image (29).png
Binary file modified .gitbook/assets/image (3) (1) (1) (1) (1) (1) (1) (1).png
Binary file modified .gitbook/assets/image (3) (1) (1) (1) (1) (1) (1).png
Binary file modified .gitbook/assets/image (3) (1) (1) (1) (1) (1).png
Binary file modified .gitbook/assets/image (3) (1) (1) (1) (1).png
Binary file modified .gitbook/assets/image (3) (1) (1) (1).png
Binary file modified .gitbook/assets/image (3) (1) (1).png
Binary file modified .gitbook/assets/image (3) (1).png
Binary file modified .gitbook/assets/image (3).png
Binary file modified .gitbook/assets/image (4) (1) (1) (1) (1) (1) (1).png
Binary file modified .gitbook/assets/image (4) (1) (1) (1) (1) (1).png
Binary file modified .gitbook/assets/image (4) (1) (1) (1) (1).png
Binary file modified .gitbook/assets/image (4) (1) (1) (1).png
Binary file modified .gitbook/assets/image (4) (1) (1).png
Binary file modified .gitbook/assets/image (4) (1).png
Binary file modified .gitbook/assets/image (4).png
Binary file modified .gitbook/assets/image (5) (1) (1) (1) (1).png
Binary file modified .gitbook/assets/image (5) (1) (1) (1).png
Binary file modified .gitbook/assets/image (5) (1) (1).png
Binary file modified .gitbook/assets/image (5) (1).png
Binary file modified .gitbook/assets/image (5).png
Binary file added .gitbook/assets/image (6) (1) (1) (1) (1).png
Binary file modified .gitbook/assets/image (6) (1) (1) (1).png
Binary file modified .gitbook/assets/image (6) (1) (1).png
Binary file modified .gitbook/assets/image (6) (1).png
Binary file modified .gitbook/assets/image (6).png
Binary file added .gitbook/assets/image (7) (1) (1) (1) (1).png
Binary file modified .gitbook/assets/image (7) (1) (1) (1).png
Binary file modified .gitbook/assets/image (7) (1) (1).png
Binary file modified .gitbook/assets/image (7) (1).png
Binary file modified .gitbook/assets/image (7).png
Binary file added .gitbook/assets/image (8) (1) (1) (1) (1).png
Binary file modified .gitbook/assets/image (8) (1) (1) (1).png
Binary file modified .gitbook/assets/image (8) (1) (1).png
Binary file modified .gitbook/assets/image (8) (1).png
Binary file modified .gitbook/assets/image (8).png
Binary file added .gitbook/assets/image (9) (1) (1) (1) (1).png
Binary file modified .gitbook/assets/image (9) (1) (1) (1).png
Binary file modified .gitbook/assets/image (9) (1) (1).png
Binary file modified .gitbook/assets/image (9) (1).png
Binary file modified .gitbook/assets/image (9).png
Binary file modified .gitbook/assets/image.png
10 changes: 4 additions & 6 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@

* [사용자 관리콘솔이란?](tmc/tenant-manager-console.md)
* [시스템 사용자 관리(SSO 통합하기)](tmc/tenant-manager-sso.md)
* [시스템 사용자 관리(권한 및 상세 편집과 삭제)](tmc/tenant-manage.md)
* [시스템 사용자 관리](tmc/tenant-manage.md)
* [프로젝트 관리](tmc/project-manage.md)
* [프로젝트 생성하기](tmc/project-create.md)
* [프로젝트 상세(프로젝트 사용자 관리)](tmc/project-detail.md)
* [프로젝트 상세](tmc/project-detail.md)

## APIM 콘솔 <a href="#apim-console" id="apim-console"></a>

Expand Down Expand Up @@ -52,16 +52,14 @@
## 개발자 포털 <a href="#devportal" id="devportal"></a>

* [개발자 포털이란?](devportal/what-is-a-devportal.md)
* [개발자 포털 관리자의 역할](devportal/devportal-admin/README.md)
* [개발자 포털 관리자 역할](devportal/devportal-admin/README.md)
* [Home 관리](devportal/devportal-admin/home-mgn.md)
* [Menu 관리](devportal/devportal-admin/menu-mgn.md)
* [Product 관리](devportal/devportal-admin/product-mgn.md)
* [API 사용 요청 관리](devportal/devportal-admin/api-approve-mgn.md)
* [개발자 포털 설정](devportal/devportal-admin/devportal-setting.md)
* [개발자 포털 멤버의 역할](devportal/undefined/README.md)
* [개발자 포털 멤버 역할](devportal/undefined/README.md)
* [기본 정보](devportal/undefined/undefined.md)
* [API KEY](devportal/undefined/api-key.md)
* [API 사용](devportal/undefined/api.md)
* [멤버 관리](devportal/undefined/undefined-1.md)
* [애플리케이션 관리자의 역할](devportal/undefined-1.md)
* [애플리케이션 멤버의 역할](devportal/undefined-2.md)
2 changes: 1 addition & 1 deletion apim-console/api-1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: 이미 배포된 API를 조회합니다.

# API 배포 현황

<figure><img src="../../.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>

배포된 API를 조회합니다.

Expand Down
2 changes: 1 addition & 1 deletion apim-console/api-1/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: 상세 페이지에서는 이전 버전을 확인하거나 배포

# API 배포 현황 상세

<figure><img src="../../.gitbook/assets/image (3) (1) (1) (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../.gitbook/assets/image (3) (1) (1) (1) (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>

API 상세 화면과 같은 구성을 두지만, 편집할 수 없습니다. 이전에 배포되었던 API의 구성을 확인할 수 있으며, 오른쪽 위 기존 버전 목록에서 이력을 확인할 수 있습니다.

Expand Down
2 changes: 1 addition & 1 deletion apim-console/api/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# API 관리

<figure><img src="../../.gitbook/assets/image (5) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../.gitbook/assets/image (5) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>

게이트웨이에 등록되는 API를 조회 또는 생성하거나 삭제합니다.

Expand Down
10 changes: 5 additions & 5 deletions apim-console/api/api-1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ API 상세 페이지는 Overview, API 문서, API Test 기능을 확인할 수

## Overview

<figure><img src="../../../.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>

Overview에서는 Frontend와 Backend 그리고 게이트웨이 정책을 확인할 수 있습니다.

Expand All @@ -20,15 +20,15 @@ Overview에서는 Frontend와 Backend 그리고 게이트웨이 정책을 확인

Overview 중심에 위치한 <mark style="background-color:blue;">정책변경</mark> 버튼을 눌러 아래와 같은 화면을 확인할 수 있습니다.

<figure><img src="../../../.gitbook/assets/image (2) (1) (1) (1) (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/image (2) (1) (1) (1) (1) (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>

각 정책에서 + 버튼을 눌러 미적용 박스에서 적용 박스로 이동 후 오른쪽 위의 저장 버튼을 눌러 API에 정책을 적용할 수 있습니다. 이때 적용 후, 반드시 새로운 배포를 진행해야 실제 API에 정책이 적용됩니다.

API 정책에 대한 자세한 내용은 API 정책 문서를 참고합니다.

## API 문서

<figure><img src="../../../.gitbook/assets/image (3) (1) (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/image (3) (1) (1) (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>

오른쪽 위의 <mark style="background-color:blue;">SWAGGER 가져오기</mark> 버튼을 눌러 API 생성 단계에서 지정한 Swagger path 호출을 통하여 문서를 불러올 수 있습니다. API 최초 생성 시, 올바른 경로를 설정하고 해당 문서가 존재한다면 자동으로 불러옵니다.

Expand All @@ -40,6 +40,6 @@ API 정책에 대한 자세한 내용은 API 정책 문서를 참고합니다.

Method 변경을 통해 Rest API 호출 Method를 지원합니다. 오른쪽 아래 <mark style="background-color:blue;">API 요청 테스트</mark> 버튼으로 요청을 진행하고 아래에서 그 결과를 확인할 수 있습니다.

<figure><img src="../../../.gitbook/assets/image (4) (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/image (4) (1) (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>

<figure><img src="../../../.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/image (1) (1) (1) (1) (1) (1) (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
2 changes: 1 addition & 1 deletion apim-console/apim-manage/apim-setting.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: APIM 전체에 해당하는 설정을 관리합니다.

# 설정

<figure><img src="../../.gitbook/assets/image (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../.gitbook/assets/image (1) (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>

APIM 콘솔 전체에 해당하는 설정을 관리합니다. 항목은 다음과 같습니다.

Expand Down
2 changes: 1 addition & 1 deletion apim-console/apim-manage/jwt.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: API jwt 정책의 JWT KEY를 관리합니다.

# JWT

<figure><img src="../../.gitbook/assets/image (2) (1) (1) (1) (1).png" alt=""><figcaption><p>JWT 홈</p></figcaption></figure>
<figure><img src="../../.gitbook/assets/image (2) (1) (1) (1) (1) (1).png" alt=""><figcaption><p>JWT 홈</p></figcaption></figure>

## JWT 란?

Expand Down
2 changes: 1 addition & 1 deletion apim-console/event.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: APIM에서 발생한 이벤트 목록을 조회하고, 상세 내

## Event 홈

<figure><img src="../.gitbook/assets/image (3) (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../.gitbook/assets/image (3) (1) (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>

사전 정의된 APIM 이벤트가 발생시 로그는 자동으로 기록되며, 이 페이지에서 보이게 됩니다.

Expand Down
6 changes: 3 additions & 3 deletions apim-console/logging/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,16 @@ description: APIM에 등록된 API의 로그 기능을 알아봅니다.

SSO 인증을 이용하는 경우 아래의 사진과 같이 테넌트 변경을 진행하여 APIM 로깅을 확인을 위한 컨텍스트로 변경합니다. SSO 인증을 사용하지 않는 경우 이 단계를 건너뜁니다.

<figure><img src="../../.gitbook/assets/image (16).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../.gitbook/assets/image (16) (1).png" alt=""><figcaption></figcaption></figure>

우측 상단 아이콘을 클릭하여 <mark style="background-color:blue;">Switch tenants</mark> 를 눌러 아래와 같은 팝업창을 불러옵니다.

<figure><img src="../../.gitbook/assets/image (14).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../.gitbook/assets/image (14) (1).png" alt=""><figcaption></figcaption></figure>

테넌트 선택 창에서 **private** 에 선택된 라디오 버튼을 **Choose from custom**으로 전환한 후**, \_apim\_tenant**로 끝나는 테넌트를 선택하고 <mark style="background-color:blue;">Confirm</mark>을 진행합니다.

테넌트가 전환이 되었다면, 좌측 메뉴에서 다음 단계를 진행합니다.

<figure><img src="../../.gitbook/assets/image (17).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../.gitbook/assets/image (17) (1).png" alt=""><figcaption></figcaption></figure>

APIM의 로그를 확인하기 위해 Discover와 Dashboard를 알아봅니다.&#x20;
2 changes: 1 addition & 1 deletion apim-console/monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: APIM 게이트웨이에 대한 메트릭을 모니터링 합니다.

# Monitoring

<figure><img src="../.gitbook/assets/image (11) (1) (1).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../.gitbook/assets/image (11) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>

APIM에서는 Prometheus를 통한 메트릭 수집을 통해 Grafana Dashboard로 모니터링 서비스를 제공합니다.

Expand Down
2 changes: 1 addition & 1 deletion apim-console/what-is-a-apim-console.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: APIM의 주 기능을 제공하는 APIM 콘솔에 대하여 알아

# APIM 콘솔이란?

<figure><img src="../.gitbook/assets/image (5) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>
<figure><img src="../.gitbook/assets/image (5) (1) (1) (1) (1) (1).png" alt=""><figcaption></figcaption></figure>

APIM 콘솔에서는 게이트웨이 생성으로 시작하여, 각 프로젝트에 생성된 게이트웨이에 등록되는 API의 관리를 지원합니다.

Expand Down
Loading

0 comments on commit 04af2b3

Please sign in to comment.