본문 바로가기

OpenAPI 작업 목록 추출기

브라우저 처리

OpenAPI(YAML·JSON)의 모든 작업을 메서드·경로·operationId·요약·태그·사용 중단 여부의 탭 구분 표로 뽑아 줍니다. 스프레드시트에 붙여 API 목록 문서를 만들 때 씁니다.

사용 전 확인
  • 파일·이미지·문서 처리 도구는 브라우저 안에서 처리되더라도 원본에 개인정보나 민감 정보가 포함될 수 있습니다. 공유·제출 전 원본과 결과를 한 번 더 확인하세요.
도구 실행입력 후 결과 확인
OpenAPI 작업 목록 추출기 샘플 실행

명세 파일이 수천 줄이 되면 어떤 엔드포인트가 있는지 한눈에 보기 어렵습니다. 이 도구는 paths 아래의 GET, POST, PUT, PATCH, DELETE 등 모든 작업을 찾아 한 줄에 하나씩 정리합니다.

브라우저 처리
샘플 결과
메서드	경로	operationId	요약	태그	상태
GET	/tools	listTools	List tools	tools
POST	/tools	createTool			사용 중단
DELETE	/tools/{id}	-	Remove
자바스크립트가 활성화되면 이 영역이 실제 입력, 실행, 결과 패널로 바뀝니다.

OpenAPI 작업 목록 추출기 사용 가이드

명세 파일이 수천 줄이 되면 어떤 엔드포인트가 있는지 한눈에 보기 어렵습니다. 이 도구는 paths 아래의 GET, POST, PUT, PATCH, DELETE 등 모든 작업을 찾아 한 줄에 하나씩 정리합니다.

열은 메서드, 경로, operationId, 요약(summary), 태그, 상태 순서이며, deprecated: true로 표시된 작업은 상태 열에 '사용 중단'으로 나옵니다. operationId가 없으면 '-'로 표시해 빠진 곳을 바로 찾을 수 있습니다.

결과는 탭으로 구분되어 엑셀이나 구글 시트에 붙이면 열이 자동으로 나뉩니다. YAML과 JSON 모두 읽으므로 openapi.yaml을 그대로 붙여 넣으면 됩니다.

사용 방법

  1. 'OpenAPI 문서' 칸에 YAML 또는 JSON 명세를 붙여 넣습니다.
  2. '실행'을 누르면 머리글 행과 함께 작업 목록이 나옵니다.
  3. 결과를 복사해 스프레드시트에 붙이고 태그나 경로로 정렬합니다.

예시: 작업 세 개 목록

입력
openapi: 3.0.3
info: {title: A, version: '1'}
paths:
  /tools:
    get:
      operationId: listTools
      summary: List tools
      tags: [tools]
    post:
      operationId: createTool
      deprecated: true
  /tools/{id}:
    delete:
      summary: Remove
결과
메서드	경로	operationId	요약	태그	상태
GET	/tools	listTools	List tools	tools
POST	/tools	createTool			사용 중단
DELETE	/tools/{id}	-	Remove

칸 사이는 탭이며, operationId가 없는 DELETE는 -로 표시됩니다.

이럴 때 쓰면 좋아요

  • API 목록을 기획·QA 팀과 공유할 스프레드시트로 만들 때
  • operationId가 빠진 작업을 찾아 코드 생성 전에 채울 때
  • 사용 중단 표시된 엔드포인트를 정리할 때
  • 두 버전의 명세에서 작업 목록을 뽑아 차이를 비교할 때

문제가 생겼을 때

'paths 아래에서 작업을 찾지 못했습니다' 결과

paths 아래 경로에 get, post 같은 소문자 메서드 키가 있어야 합니다. GET처럼 대문자로 쓴 키는 OpenAPI 규칙상 작업으로 인정되지 않습니다.

YAML 오류가 나서 목록이 안 나옴

알려 준 행의 들여쓰기나 탭을 확인하세요. 문법 검사와 자세한 점검은 OpenAPI 포맷터·검사기로 먼저 하는 것이 편합니다.

활용 팁

  • 경로 순서는 명세에 적힌 순서를 따릅니다. 정렬이 필요하면 결과를 CSV 행 정렬기나 스프레드시트에서 정렬하세요.
  • 같은 경로의 여러 메서드는 GET, PUT, POST, DELETE 순서로 나옵니다.

자주 묻는 질문

매개변수나 응답 형식도 표에 넣을 수 있나요?

이 도구는 작업 목록만 만듭니다. 매개변수와 응답 구조는 OpenAPI 포맷터·검사기의 정리된 JSON에서 확인하세요.

$ref로 분리된 paths 파일도 읽나요?

다른 파일은 읽지 않습니다. 하나로 합친(번들한) 명세를 붙여 넣으세요.

영어 페이지에서는 머리글이 영어인가요?

네. 영어 페이지에서는 method, path, operationId 같은 영어 머리글과 deprecated 표시를 씁니다.