API Search
🔍 API 검색
개요
API 검색은 등록된 API를 다양한 조건으로 검색하고 조회할 수 있는 통합 검색 기능입니다.
경로: 좌측 사이드바 > API 검색
기능 설명
API 검색 페이지에서는 프로젝트, Gateway URL(Domain), API 이름, 경로, 메소드 등 다양한 조건으로 API를 검색하고 결과를 확인할 수 있습니다. 검색 결과는 테이블 또는 카드 형태로 조회할 수 있으며, CSV, JSON, Excel 형식으로 내보낼 수 있습니다.
페이지 구성
1. Search Filters (검색 필터) 섹션
검색 조건을 설정하는 필터 영역입니다.
필터 옵션
| 필터 항목 | 설명 | 입력 예시 |
|---|---|---|
| Project | 프로젝트 선택 (다중 선택 가능) | 드롭다운에서 프로젝트 선택 |
| Method | HTTP 메소드 필터 (GET, POST, PUT, DELETE 등) | GET, POST 등 선택 |
| Gateway URL | Gateway URL 키워드 검색 (Like 검색) | api.skapim.com |
| API Name | API 이름 키워드 검색 (Like 검색) | api01 |
| Request (Body, Parameters) | 요청 Body 또는 QueryParameters, PathParameters 키워드 검색 | orderId, userId |
| Response (Body) | 응답 Body 키워드 검색 | orderId, userId |
| API Base Path | API Base Path 검색 | /api/v1/orders |
| Path | API Base Path 이후의 | |
| API 경로(Path) 검색 | /api/v1/orders | |
| Swagger Tag | Swagger Tag 검색 | order |
| Description or Summary | 설명 또는 요약 키워드 검색 (Like 검색) | 설명이나 요약에 포함된 키워드 입력 |
검색 필터 버튼
- Reset: 모든 검색 조건을 초기화합니다
- Search: 설정한 검색 조건으로 API를 검색합니다
검색 필터 동작 방식
1. 필터 간 조건 결합 (AND 조건)
각 검색 필터들은 서로 AND 조건으로 결합됩니다.
예시:
Project A AND Method GET
- Project가 "A"이고 동시에 Method가 "GET"인 API만 검색됩니다
2. 필터 내 다중 값 결합 (OR 조건)
하나의 필터 내에서 여러 값을 선택하거나 입력하면 OR 조건으로 결합됩니다.
예시:
Project A AND (Method GET OR POST)
- Project가 "A"이고, Method가 "GET" 또는 "POST"인 API를 검색합니다
3. 키워드 검색 (LIKE 검색)
모든 필터 입력값(KEYWORD)은 값이 포함되면 검색합니다 (LIKE %KEYWORD% 검색).
특징:
- 대소문자 구분 여부는 시스템 설정에 따라 다를 수 있습니다
- 부분 일치 검색이 가능하므로 정확한 값 전체를 입력할 필요가 없습니다
예시:
- Gateway URL에
api입력 →api.skapim.com,apistg.skapim.com등 검색 - API Name에
auth입력 →my-core-auth,user-auth,auth-service등 검색 - Description에
login입력 → 설명에 "login"이 포함된 모든 API 검색
복합 검색 예시:
| 필터 설정 | 검색 결과 |
|---|---|
Project: pjt01 | |
Method: GET | Project가 "pjt01" |
| AND | |
| Method가 "GET"인 API | |
Gateway URL: api | |
API Name: auth | Gateway URL에 "api" 포함 |
| AND | |
| API Name에 "auth" 포함 | |
Method: GET OR POST | |
Path: /v1 | (Method가 "GET" OR "POST") AND Path에 "/v1" 포함 |
💡 팁:
- 여러 필터를 조합(AND)하여 원하는 API를 정확하게 찾을 수 있습니다
- 하나의 필터에 여러 값(OR)을 설정하면 더 넓은 범위의 검색이 가능합니다
- 키워드 검색(LIKE)을 활용하면 정확한 이름을 입력하지 않아도, 부분 일치로 검색할 수 있습니다
2. 검색 결과 영역
통계 정보
검색 결과 상단에 다음 통계 정보가 표시됩니다:
- Total APIs: 검색된 전체 API 개수
- Total Endpoints: 검색된 전체 엔드포인트 개수
- Related Projects: 관련 프로젝트 개수
뷰 모드 전환
- Table View: 테이블 형태로 검색 결과를 표시합니다 (기본)
- Card View: 카드 형태로 검색 결과를 표시합니다
Export 기능
검색 결과를 파일로 내보낼 수 있습니다:
- CSV: CSV 형식으로 내보내기
- JSON: JSON 형식으로 내보내기
- Excel: Excel 형식으로 내보내기
Column Settings
테이블에 표시할 컬럼을 선택할 수 있습니다.
3. 검색 결과 테이블
테이블 컬럼
| 컬럼명 | 설명 |
|---|---|
| Project Name | 프로젝트 이름 |
| API Name | API 이름 |
| Gateway URL | Gateway URL |
| API Base Path | API Base Path |
| Path | API 경로 (예: /v1/poc-tcom-cd/...) |
| Swagger Tag | Swagger Tag |
| Method | HTTP 메소드 (GET, POST, PUT 등) |
| Summary | API 요약 정보 |
| Description | API 설명 |
| Details | 상세 정보 보기 |
테이블 기능
- 페이징: 검색 결과가 많을 경우 페이지 단위로 조회 (예: 1페이지당 10개 항목)
- 정렬: 컬럼 헤더 클릭으로 정렬 기준 변경 (가능한 경우)
- 상세 조회: Details 컬럼의 버튼으로 상세 정보 확인
- Method 태그: Method는 색상 태그(Chip)로 표시됩니다 (get, post, put 등)
사용 방법
기본 검색
- 좌측 사이드바에서 "API 검색" 메뉴를 선택합니다
- Search Filters 섹션에서 원하는 검색 조건을 설정합니다
- Search 버튼을 클릭하여 검색을 실행합니다
고급 검색 예시
예시 1: 특정 프로젝트의 GET 메소드 API 검색
- Project 드롭다운에서 프로젝트 선택
- Method 드롭다운에서 "GET" 선택
- Search 버튼 클릭
예시 2: Gateway URL로 API 검색
- Gateway URL 입력 필드에
api.skapim.com입력 - Search 버튼 클릭
예시 3: API 이름과 설명으로 검색
- API Name 입력 필드에
bw-core-auth입력 - Description or Summary 입력 필드에 키워드 입력
- Search 버튼 클릭
예시 4: 경로 패턴으로 검색
- Path 입력 필드에
/api/v1/orders입력 - Search 버튼 클릭
검색 결과 활용
- 테이블/카드 뷰 전환: Table View 또는 Card View 버튼으로 보기 방식 변경
- 상세 정보 확인: 테이블의 Details 컬럼 버튼 클릭
- 결과 내보내기: CSV, JSON, 또는 Excel 버튼 클릭하여 파일 다운로드
- 컬럼 설정: Column Settings 버튼으로 표시할 컬럼 선택
검색 조건 초기화
- Reset 버튼을 클릭하면 모든 검색 필터가 초기화됩니다
주요 기능 상세
키워드 검색 (LIKE 검색)
모든 키워드 입력 필드는 LIKE %KEYWORD% 검색을 지원합니다. 값이 포함되면 검색됩니다.
키워드 검색 필드:
- Gateway URL: Gateway URL에 포함된 키워드 검색
- API Name: API 이름에 포함된 키워드 검색
- Request (Body, Parameters): 요청 Body 또는 Parameters에 포함된 키워드 검색
- Response (Body): 응답 Body에 포함된 키워드 검색
- API Base Path: API Base Path에 포함된 키워드 검색
- Path: API 경로에 포함된 키워드 검색
- Swagger Tag: Swagger Tag에 포함된 키워드 검색
- Description or Summary: 설명이나 요약에 포함된 키워드 검색
예시:
- Gateway URL에
otel입력 →otel-gw.api.skapim.com등 검색 - API Name에
auth입력 →bw-core-auth,user-auth등 검색 - Path에
/v1/board입력 →/v1/board,/v1/board/{id}등 검색
💡 팁: 부분 일치 검색이 가능하므로 정확한 이름을 몰라도 키워드만 입력하면 검색할 수 있습니다.
다중 조건 검색
여러 필터를 동시에 사용하여 더 정확한 검색이 가능합니다. 예를 들어:
- Project + Method 조합
- Gateway URL + API Name 조합
- Path + Swagger Tag 조합
결과 내보내기
검색 결과를 다양한 형식으로 내보낼 수 있어 다른 도구에서 활용하거나 문서화에 사용할 수 있습니다:
- CSV: 스프레드시트에서 열기
- JSON: 프로그래밍 방식으로 처리
- Excel: Excel 파일로 저장
활용 팁
- 검색 조건 조합: 여러 필터를 조합하여 원하는 API를 빠르게 찾으세요
- 키워드 검색 활용: 정확한 이름을 모를 때 키워드 검색을 활용하세요
- 통계 정보 확인: 검색 결과 상단의 통계 정보로 전체 규모를 파악하세요
- View 모드 전환: 테이블 뷰와 카드 뷰를 전환하여 선호하는 방식으로 확인하세요
- Export 기능: 검색 결과를 파일로 저장하여 공유하거나 문서화에 활용하세요
- 페이징 활용: 검색 결과가 많을 경우 페이징을 활용하여 효율적으로 탐색하세요
API 상세 정보 (Details)
접근 방법: 검색 결과 테이블의 Details 컬럼 버튼 클릭
검색 결과 테이블에서 각 API 행의 Details 버튼을 클릭하면 해당 API의 상세 정보를 확인할 수 있는 모달 창이 표시됩니다.
모달 구성
모달 창 특징
- 오버레이: 배경 어두운 오버레이로 모달 외부 영역을 차단합니다
- 반응형 디자인: 모달 크기는 화면 크기에 맞춰 자동 조정됩니다
- 닫기 기능: 모달 외부 클릭 또는 닫기 버튼(✕)으로 닫을 수 있습니다
주요 섹션
1. API 정보 섹션 (api-info-section)
API 기본 정보를 표시합니다:
- API Name: API 이름 (예:
bw-core-auth) - Base Path: API Base Path (예:
/bw-core-auth) - Gateway URL: Gateway URL (예:
otel-gw.api.skapim.com) - Open API Document: OpenAPI 문서 링크 버튼
2. 엔드포인트 섹션 (endpoints-section)
Swagger 정보와 엔드포인트 목록을 표시합니다:
- Swagger 정보:
- 총 엔드포인트 개수 (예:
198 endpoints)
- 총 엔드포인트 개수 (예:
- 엔드포인트 목록:
- Method: HTTP 메소드 (GET, POST, PUT 등) - 칩 형태로 표시
- Path: API 경로 (예:
/v1/poc-tcom-cd/get-plyz-ppay-yn) - Summary: API 요약 (예:
getPlayzPpayYn) - Swagger Tag: Swagger Tag (예:
poc-tcom-cd-controller) - Related Endpoints: 관련 엔드포인트 버튼
주요 기능
1. 엔드포인트 정보 확인
- 각 엔드포인트의 Method, Path, Summary, Swagger Tag 정보를 확인할 수 있습니다
- Method는 색상 태그(Chip)로 표시되어 시각적으로 구분됩니다
2. API 엔드포인트 테스트/실행
- 각 엔드포인트 목록의 오른쪽에 위치한 **재생 버튼 (▶)**을 클릭하면 해당 API 엔드포인트의 테스트 화면 또는 실행 화면으로 이동합니다
- 재생 버튼을 클릭하면:
- API 테스트 인터페이스가 표시되거나
- API 호출 실행 화면으로 이동하거나
- 해당 엔드포인트의 상세 실행 정보를 확인할 수 있습니다
- 이 기능을 통해 API를 직접 테스트하고 동작을 확인할 수 있습니다
3. 관련 엔드포인트 탐색
- Related Endpoints 버튼을 클릭하면 관련된 다른 엔드포인트를 확인할 수 있습니다
4. OpenAPI 문서 열기
- Open API Document 버튼을 클릭하면 해당 API의 OpenAPI 문서를 확인할 수 있습니다
5. 모달 닫기
- 모달 우측 상단의 닫기 버튼(✕) 클릭
- 또는 모달 외부(오버레이) 클릭
사용 방법
- API 검색 실행: 검색 필터를 설정하고 Search 버튼을 클릭하여 검색 결과를 표시합니다
- Details 버튼 클릭: 검색 결과 테이블에서 원하는 API 행의 Details 컬럼 버튼을 클릭합니다
- 모달 확인: API 상세 정보 모달이 열립니다
- 정보 확인:
- API 정보 섹션에서 API 기본 정보를 확인합니다
- 엔드포인트 섹션에서 Swagger 정보와 엔드포인트 목록을 확인합니다
- 각 엔드포인트 옆의 **재생 버튼 (▶)**을 클릭하여 API 테스트/실행 화면으로 이동할 수 있습니다
- Related Endpoints 버튼을 클릭하여 관련 엔드포인트를 탐색할 수 있습니다
- Open API Document 버튼을 클릭하여 OpenAPI 문서를 확인할 수 있습니다
- 모달 닫기:
- 모달 우측 상단의 닫기 버튼(✕)을 클릭하거나
- 모달 외부(오버레이)를 클릭하여 모달을 닫습니다
활용 예시
예시 1: API 기본 정보 확인
- 검색 결과에서
bw-core-authAPI의 Details 버튼 클릭 - API 정보 섹션에서 Base Path와 Gateway URL 확인
- 엔드포인트 개수 확인 (예: 198개)
예시 2: 특정 엔드포인트 정보 확인
- Details 모달에서 엔드포인트 목록 확인
- Method 태그로 GET/POST/PUT 구분
- Path와 Summary를 통해 엔드포인트 기능 파악
예시 3: OpenAPI 문서 확인
- Details 모달에서 Open API Document 버튼 클릭
- 새 창 또는 탭에서 OpenAPI 문서 확인
예시 4: API 엔드포인트 테스트
- Details 모달에서 테스트하고 싶은 엔드포인트 찾기
- 해당 엔드포인트 옆의 재생 버튼 (▶) 클릭
- API 테스트/실행 화면에서 API를 직접 호출하고 결과 확인
- 요청 파라미터, 헤더, Body 등을 설정하여 다양한 시나리오 테스트
예시 5: 관련 엔드포인트 탐색
- 특정 엔드포인트의 Related Endpoints 버튼 클릭
- 관련된 다른 엔드포인트 목록 확인
API Test 팝업 활용
- 재생 버튼 클릭: 엔드포인트 오른쪽 재생 버튼(▶)을 누르시면 API Test 팝업이 열립니다.
- Try it out 실행: Swagger UI의 Try it out을 눌러 호출을 실행하시고, 우측 패널에서 결과를 확인하실 수 있습니다.
- 확인 항목: 응답 코드, 응답 바디, 응답 소요 시간 등
- History 저장: 결과 우측 상단 세이브 버튼을 누르시면 테스트 결과가 History에 저장됩니다.
- History 조회: 상단 History 탭에서 저장된 이력을 확인하실 수 있습니다.
- Share 링크 공유: History 항목의 Share 버튼으로 테스트 이력을 링크 형태로 공유하실 수 있습니다.
- 링크 재접속: 공유된 링크를 브라우저 주소창에 붙여넣으시면 저장된 History 화면으로 이동해 동일한 테스트 내용을 확인하실 수 있습니다.
