API Search

🔍 API 검색

개요

API 검색은 사용자가 다양한 조건을 사용하여 등록된 API를 검색하고 볼 수 있는 통합 검색 기능입니다.

Path: Left Sidebar > API Search

기능 Overview

API 검색 페이지에서 사용자는 프로젝트, 게이트웨이 URL(도메인), API 이름, 경로, 메서드 등과 같은 여러 조건을 사용하여 API의 결과를 검색하고 볼 수 있습니다. 검색 결과는 테이블 보기 또는 카드 보기로 볼 수 있으며, CSV, JSON 또는 Excel 형식으로 내보낼 수 있습니다.

---

페이지 구조

1. 검색 필터 섹션

이 섹션에서는 사용자가 검색 조건을 정의하기 위해 필터를 설정할 수 있습니다.

Filter Options 

Filter Item	Description	Example Input
Project	프로젝트 선택(다중 선택 지원)	드롭다운에서 프로젝트 선택
Method	HTTP 메서드 필터(GET, POST, PUT, DELETE 등)	GET, POST 등 선택
Gateway URL	게이트웨이 URL 키워드 검색(유사 검색)	api.skapim.com
API Name	API 이름 키워드 검색(유사 검색)	api01
Request (Body, Parameters)	요청 본문, 쿼리 매개변수, 경로 매개변수 내 키워드 검색	orderId, userId
Response (Body)	응답 본문 내 키워드 검색	orderId, userId
API Base Path	API 기본 경로 검색	/api/v1/orders
Path	API 기본 경로 이후의 API 경로 검색.	/api/v1/orders
Swagger Tag	Swagger 태그 검색	order
Description or Summary	설명 또는 요약 키워드 검색(유사 검색)	설명 또는 요약에 포함된 키워드를 입력하세요.
Search Filter Buttons

• Reset: 모든 필터를 지웁니다
• Search: 선택한 조건으로 검색을 실행합니다

검색 필터 작동 방식

1. Combine conditions between filters (AND condition)

각 필터는 AND condition와 결합됩니다.

Example:

Project A AND Method GET

• "A" 프로젝트와 "GET" 메서드를 가진 API만 검색됩니다.

2. 단일 필터 내에서 여러 값을 결합하기 (OR 조건)

단일 필터 내에서 여러 값을 선택하거나 입력하면, 이들은 OR 조건을 사용하여 결합됩니다.

예시:

Project A AND (Method GET OR POST)

• "A" 프로젝트와 "GET" 또는 "POST" 메서드를 가진 API가 검색됩니다.

3. Keyword Search (LIKE Search)

모든 필터 입력 값 (KEYWORD)은 입력된 값과 contain 경우 검색됩니다 (LIKE %KEYWORD% 검색).

Features:

• 대소문자 구분은 시스템 구성에 따라 다를 수 있습니다.
• 부분 일치 검색이 지원되므로 전체 정확한 이름이 필요하지 않습니다.

Example:

• Gateway URL에 api 입력 → api.skapim.com, apistg.skapim.com 등이 검색됩니다.
• API 이름에 auth 입력 → my-core-auth, user-auth, auth-service 등이 검색됩니다.
• 설명에 login 입력 → “login”이 포함된 모든 API가 검색됩니다.

Composite Search Example:

Filter Setting	Search Result
Project: pjt01 Method: GET	"pjt01" 프로젝트와 "GET" 메서드를 가진 API
Gateway URL: api API Name: auth	"api"가 Gateway URL 에 포함되고 "auth"가 API 이름에 포함됩니다
메서드: GET 또는 POST 경로: /v1	(메서드는 "GET" 또는 "POST") 그리고 "/v1"이 경로에 포함됩니다.

💡 Tips:

• 여러 필터를 결합(AND)하여 API 검색 결과를 정확하게 좁힐 수 있습니다.
• 단일 필터 내에서 여러 값을 설정(OR)하면 더 넓은 검색 범위를 허용합니다.
• 키워드 검색(LIKE)은 부분 일치를 지원하므로 전체 정확한 이름이 필요하지 않습니다.

---

2. Search Results Area

Statistics Information

검색 결과 상단에 다음 통계가 표시됩니다:

• Total APIs – 일치하는 API 수
• Total Endpoints – 일치하는 엔드포인트 수
• Related Projects – 관련 프로젝트 수

Switch View Mode

• Table View: 검색 결과를 테이블 형식으로 표시합니다(기본값).
• Card View: 검색 결과를 카드 형식으로 표시합니다.

Export Function

검색 결과는 파일로 내보낼 수 있습니다:

• CSV: CSV 형식으로 내보내기
• JSON: JSON 형식으로 내보내기
• Excel: Excel 형식으로 내보내기

Column Settings

테이블에 표시할 열을 선택할 수 있습니다.

---

3. 검색 결과 테이블

Table Columns:

Column name	설명
프로젝트 이름	프로젝트 이름
API 이름	API 이름
게이트웨이 URL	게이트웨이 URL
API 기본 경로	API 기본 경로
경로	API 경로 (예: /v1/poc-tcom-cd/...)
스웨거 태그	스웨거 태그
메서드	HTTP 메서드 (GET, POST, PUT 등)
요약	API 요약 정보
설명	API 설명
세부정보	자세한 정보 보기

Table Functions:

• Pagination: 검색 결과 수가 많을 때 페이지별로 결과를 표시합니다(예: 페이지당 10개 항목).
• Sorting: 열 헤더를 클릭하여 정렬 순서를 변경할 수 있습니다(지원되는 경우).
• Details: 버튼을 통해 Details 열에서 자세한 정보를 표시합니다.
• Method Tag: 메서드는 GET, POST, PUT 등과 같은 색상 코드가 있는 태그(칩)로 표시됩니다.

---

사용 방법

기본 검색

1. 왼쪽 사이드바에서 “API Search” 메뉴를 선택합니다.
2.  Search Filters  섹션에서 원하는 검색 조건을 설정합니다.
3. Search  버튼을 클릭하여 검색을 실행합니다.

고급 검색 예제

Example 1: Search for GET‑method APIs in a specific project  

1. Project  드롭다운에서 프로젝트를 선택합니다.
2. Method 드롭다운에서 “GET” 양식을 선택합니다.
3. Search  버튼을 클릭합니다.

Example 2: Search for APIs by Gateway URL  

1. Gateway URL 입력 필드에 api.skapim.com을 입력합니다.
2. Search 버튼을 클릭합니다.

Example 3: Search by API Name & Description  

1. API name 입력 필드에 bw-core-auth를 입력합니다.
2.  Description or Summary 입력 필드에 키워드를 입력합니다.
3. Search  버튼을 클릭합니다.

Example 4: Search by Path pattern  

1. Path 입력 필드에 /api/v1/orders를 입력합니다.
2. Search  버튼을 클릭합니다.

검색 결과 사용 방법

1. Switch between table and card view: Table View 또는 Card View 버튼을 사용하여 표시 모드를 변경합니다.
2. View details: 테이블의 Details 열에서 버튼을 클릭합니다.
3. Export results: CSV, JSON 또는 Excel 버튼을 클릭하여 파일을 다운로드합니다.
4. Column settings: Column Settings 버튼을 사용하여 표시할 열을 선택합니다.

검색 조건 초기화

• Reset 버튼을 클릭하여 모든 검색 필터를 초기화합니다.

---

주요 기능 상세

키워드 검색 (LIKE 검색)

모든 키워드 입력 필드는 LIKE %KEYWORD% 검색을 지원합니다. 값이 포함되어 있으면 검색됩니다.

Keyword Search Fields:

• Gateway URL: 게이트웨이 URL에 포함된 키워드를 검색합니다.
• API Name: API 이름에 포함된 키워드를 검색합니다.
• Request (Body, Parameters): 요청 본문 또는 매개변수에 포함된 키워드를 검색합니다.
• Response (Body): 응답 본문에 포함된 키워드를 검색합니다.
• API Base Path: API 기본 경로에 포함된 키워드를 검색합니다.
• Path: API 경로에 포함된 키워드를 검색합니다.
• Swagger Tag: 스웨거 태그에 포함된 키워드를 검색합니다.
• Description or Summary: 설명 또는 요약에 포함된 키워드를 검색합니다.

Example:

• 게이트웨이 URL에 otel 입력 → otel-gw.api.skapim.com 등이 검색됩니다.
• API 이름에 auth 입력 → bw-core-auth, user-auth 등이 검색됩니다.
• 경로에 /v1/board 입력 → /v1/board, /v1/board/{id} 등이 검색됩니다.

💡 Tips: 부분 일치 검색이 지원되므로 전체 정확한 이름이 필요하지 않습니다.

다중 조건 검색

여러 필터를 함께 사용하면 더 정밀한 검색이 가능합니다. 예를 들면:

• 프로젝트 + 메서드
• 게이트웨이 URL + API 이름
• 경로 + 스웨거 태그

결과 내보내기

검색 결과는 다른 도구나 문서에서 사용하기 위해 다양한 형식으로 내보낼 수 있습니다:

• CSV: 스프레드시트에서 열 수 있습니다.
• JSON: 프로그램 처리에 적합합니다.
• Excel: 결과를 Excel 파일로 저장합니다.

---

사용 팁

1. Combine Search Conditions: 여러 필터를 사용하여 원하는 API를 빠르게 찾습니다.
2. Use Keyword Search: 정확한 이름을 모를 때 유용합니다.
3. Check Statistics information: 결과 상단의 통계를 사용하여 전체 범위를 이해합니다.
4. Switch View mode: 선호도에 따라 테이블 보기와 카드 보기 전환
5. Use Export options: 공유 또는 문서 작성을 위한 검색 결과 저장
6. Use Pagination: 결과가 많을 때 효율적인 탐색을 위해 페이지 매김 사용

---

API 상세 정보

How to Access: 검색 결과 테이블의 Details 열에서 버튼 클릭.

검색 결과 테이블에서 API의 Details 버튼을 클릭하면 해당 API에 대한 상세 정보가 표시되는 모달 창이 열립니다.

모달 구조

Modal Features

• Overlay: 어두운 오버레이가 모달 외부의 상호작용을 차단합니다.
• Responsive Design: 화면 크기에 따라 자동으로 크기를 조정합니다.
• Close Options: 모달 외부를 클릭하거나 닫기 버튼(✕)을 사용하세요.

주요 섹션

1. API Information Section (api-info-section)

기본 API 정보를 표시합니다:

• API Name: API 이름 (예: bw-core-auth)
• Base Path: API 기본 경로 (예: /bw-core-auth)
• Gateway URL: 게이트웨이 URL (예: otel-gw.api.skapim.com)
• Open API Document: OpenAPI 문서 링크를 열기 위한 버튼

2. Endpoints Section (endpoints-section)

Swagger 정보 및 엔드포인트 목록을 표시합니다:

• Swagger Information:
  • 총 엔드포인트 수 (예: 198 엔드포인트)
• Endpoint List :
  • Method: HTTP 메서드 (GET, POST, PUT 등), 칩 형식으로 표시
  • Path: API 경로 (예: /v1/poc-tcom-cd/get-plyz-ppay-yn)
  • Summary: API 요약 (예: getPlayzPpayYn)
  • Swagger Tag: Swagger 태그 (예: poc-tcom-cd-controller)
  • Related Endpoints: 관련 엔드포인트 보기 버튼

주요 기능

1. View Endpoint Information

• 각 엔드포인트에 대한 메서드, 경로, 요약 및 스웨거 태그 정보를 볼 수 있습니다.
• 메서드는 쉽게 시각적으로 구분할 수 있도록 색상 코드가 지정된 칩으로 표시됩니다.

2. Test or Execute an API Endpoint

• 각 엔드포인트의 오른쪽에 위치한 **재생 버튼 (▶)**를 클릭하면 해당 API 엔드포인트의 테스트 화면 또는 실행 화면으로 이동할 수 있습니다.
• 재생 버튼을 클릭하면:
  • API 테스트 인터페이스가 표시되거나,
  • 실행 화면으로 이동하거나,
  • 자세한 실행 정보가 표시됩니다.
• 이 기능을 통해 API를 직접 테스트하고 동작을 검증할 수 있습니다.

3. Browse Related Endpoints

• Related Endpoints 버튼을 클릭하면 다른 관련 엔드포인트가 표시됩니다.

4. Open the OpenAPI Document

• Open API Document를 클릭하여 이 API의 전체 OpenAPI 문서를 엽니다.

5.  Close the Modal

• 모달의 오른쪽 상단에 있는 ✕ 버튼을 클릭합니다.
• 또는 모달 외부(오버레이 영역)를 클릭합니다.

How to Use

1. Run API search: 검색 필터를 설정하고 Search  버튼을 클릭하여 결과를 표시합니다.
2. Click Details button: 검색 결과 테이블에서 원하는 API 행의 세부정보 열에 있는 Details  버튼을 클릭합니다.
3. View the modal: API 세부정보 모달이 열립니다.
4. Check information:
   • API Information section에서 기본 API 정보를 볼 수 있습니다.
   • Endpoints section에서 스웨거 정보와 엔드포인트 목록을 볼 수 있습니다.
   • 엔드포인트 옆에 있는 **재생 버튼(▶)**을 클릭하여 API 테스트 또는 실행 화면으로 이동합니다.
   • Related Endpoints 버튼을 클릭하여 관련 엔드포인트를 탐색합니다.
   • Open API Document 버튼을 클릭하여 OpenAPI 문서를 봅니다.
5. Close the Modal

• 모달의 오른쪽 상단에 있는 닫기 버튼 (✕)을 클릭하거나
  • 모달 (오버레이) 외부를 클릭하여 닫습니다.

사용 예시

Example 1: Checking basic API information

1. 검색 결과에서 bw-core-auth API의 세부정보 버튼을 클릭합니다.
2. API 정보 섹션에서 기본 경로 및 게이트웨이 URL을 확인합니다.
3. 엔드포인트 수를 확인합니다 (예: 198 ae).

Example 2: Viewing specific endpoint information

1. 세부정보 모달에서 엔드포인트 목록을 확인합니다.
2. 메서드 태그를 사용하여 GET/POST/PUT을 구분합니다.
3. 각 엔드포인트의 경로 및 요약을 통해 기능을 이해합니다.

Example 3: Viewing OpenAPI documentation 

1. 세부정보 모달에서 Open API Document 버튼을 클릭합니다.
2. 새 창이나 탭에서 OpenAPI 문서를 봅니다.

Example 4: Testing an API endpoint 

1. 세부정보 모달에서 테스트할 엔드포인트를 찾습니다.
2. 해당 엔드포인트 옆에 있는 Play button (▶) 를 클릭합니다.
3. API 테스트/실행 화면에서 API를 직접 호출하고 결과를 확인합니다.
4. 다양한 시나리오를 테스트하기 위해 요청 매개변수, 헤더 및 본문을 구성/설정합니다.

Example 5: Viewing related endpoints 

1. 선택한 엔드포인트에 대한 Related Endpoints 버튼을 클릭합니다.
2. 다른 관련 엔드포인트 목록을 확인합니다.

How to use the API Test popup

• Click Play button: 엔드포인트의 오른쪽에 있는 재생 버튼 (▶)을 클릭하면 API Test 팝업이 열립니다.

• Execute Try it out : Swagger UI에서 Try it out 를 클릭하여 호출하고 오른쪽 패널에서 결과를 봅니다. 

  • 확인할 항목: Response code, response body, response time, 등.

• Save to History: 결과 패널의 오른쪽 상단에 있는 Save 버튼을 클릭하여 테스트 결과를 기록에 저장합니다.

• View History: 상단의 History  탭을 열어 저장된 테스트 기록을 확인하세요.

• Share a Link: History에서 Share  버튼을 클릭하여 테스트 결과를 링크로 공유하세요.

• Reopening the Link: 공유된 링크를 브라우저 주소창에 붙여넣어 저장된 History 화면을 열고 동일한 테스트 세부정보를 검토하세요.