1.2. 3scale 기본 개발자 포털 수정
Echo API 개발자 포털을 탐색한 후 고유한 개발자 포털을 생성하기 전에 이를 변경합니다. 이러한 실습 단계는 개발자 포털 생성을 준비하는 데 도움이 됩니다.
이 절차는 샘플 3scale Echo API 랜딩 페이지 제목을 일반 Swagger Petstore API의 제목으로 대체합니다. 또한 Petstore API에 대한 문서를 표시하도록 개발자 포털을 업데이트하는 방법을 보여줍니다.
절차
- 3scale 관리 포털의 맨 위에 있는 컨텍스트 선택기를 확장하고 NetNamespace를 클릭합니다.
- 왼쪽 탐색 트리에서 개발자 포털 을 확장하고 콘텐츠 를 클릭합니다.
루트 아래에서 개발자 포털의 내부 제목인 Homepage 를 클릭하고 개발자 포털의 개발 버전에 표시되는 시작 페이지 제목을 변경합니다.
- '홈페이지' 에서 아래로 스크롤하여 랜딩 페이지를 렌더링하는 코드를 확인합니다.
5행에서 변경<h1>Echo API</h1>
다음으로 변경
<h1>Petstore API</h1>
- 페이지 하단에서 게시 를 클릭합니다.
- 개발자 포털 아래에 있는 탐색 트리에서 포털 방문을 클릭하여 개발자 포털 의 개발 버전을 표시하고 랜딩 페이지 제목이 이제 Petstore API 임을 확인합니다.
- 개발자 포털의 개발 버전에 남아 있고 상단 메뉴 표시줄에 있는 문서 를 클릭합니다. 개발자 포털에는 Echo API의 ActiveDocs가 표시됩니다.
- 3scale 관리 포털로 돌아가서 개발자 포털 > ActiveDocs 를 선택하여 Echo API 항목을 확인합니다. 3scale은 Echo API를 정의하는 OpenAPI 문서를 제공합니다. 3scale은 이 OpenAPI 문서를 사용하여 Echo API의 ActiveDocs를 표시합니다.
Swagger Petstore API를 정의하는 OpenAPI 문서를 가져옵니다.
- https://petstore.swagger.io/v2/swagger.json 로 이동하여 JSON 콘텐츠를 클립보드에 복사합니다.
- 개발자 포털 > ActiveDocs를 선택하여 3scale 관리 포털 로 돌아갑니다.
- ActiveDocs 페이지에서 새 사양 생성을 클릭합니다.
-
이름 필드에
Petstore를 입력합니다. - 게시 를 선택합니다. .
- API JSON Spec 창을 클릭하고 클립보드에서 Swagger Petstore JSON 콘텐츠를 붙여넣습니다.
- 페이지 하단에서 Create Spec 를 클릭합니다. 3scale은 Petstore API의 ActiveDocs를 표시합니다.
- 왼쪽 탐색 트리의 개발자 포털 의 ActiveDocs 를 클릭합니다. Echo API 후, Petstore 에 대한 두 번째 항목이 있습니다.
개발자 포털에 Petstore API에 대한 문서를 표시합니다.
- 왼쪽 탐색 트리의 개발자 포털 의 콘텐츠를 클릭합니다.
- 루트 페이지에서 개발자 포털 설명서 페이지의 내부 제목인 문서 를 클릭합니다.
페이지 '설명서' 에서 아래로 스크롤하여 문서 시작 페이지를 렌더링하는 코드를 확인합니다. 라인
5는 개발자 포털에서 ActiveDocs를 표시하는 OpenAPI 문서를 식별합니다. 행5의 기본값은 다음과 같습니다.{% assign spec = provider.api_specs.first %}기본 동작은 개발자 포털에서 개발자 포털 > ActiveDocs 페이지에서 첫 번째 항목에 대해 ActiveDocs 를 표시하는데, 처음에는 Echo API입니다. 이 그림은 다음
5번 라인에 대해 강조합니다.
행
5를 수정하여 ActiveDocs 페이지에서 두 번째 항목을 식별하는 인덱스를 갖도록provider.api_specs.first을 변경합니다.{% assign spec = provider.api_specs[1] %}기본 동작은 개발자 포털에서 하나의 OpenAPI 문서에만 ActiveDocs를 표시하는 것입니다. 둘 이상의 OpenAPI 문서에 대한 ActiveDocs를 표시하려면 이 간단한 변경 이외의 문서 페이지를 수정해야 합니다.
- 페이지 하단에서 게시 를 클릭합니다.
- 개발자 포털 왼쪽의 탐색 트리에서 방문 포털 을 클릭하여 개발자 포털의 개발 버전을 표시합니다.
- 상단 메뉴 모음에서 문서 를 클릭하여 Swagger Petstore 문서를 참조하십시오.
다음 단계
기본 개발자 포털 페이지를 변경하여 개발자 포털 생성을 시작하여 API에 대한 3scale 관리 API 및 문서에 대한 액세스 정보를 표시합니다.