본문으로 건너뛰기

노출 작업

스펙의 모든 작업을 공개해야 하는 것은 아닙니다. 관리 인터페이스, 내부 도구, 초안 작업은 문서에 남겨두면서 공개 문서와 MCP에서 숨겨야 하는 경우가 많습니다. 노출 구성은 이 선택을 명확히 하고 원본 문서를 바꾸지 않습니다.

작동 방식​

노출 구성은 스펙과 별도로 저장됩니다. 각 기록은 작업을 참조하고 활성 여부를 기록합니다.

  • 있으면 작업의 operationId 우선.
  • 작업 ID가 없는 스펙과 검증을 위해 method, path도 저장.

원본 파일은 불변입니다. 문서와 MCP는 스펙과 활성 작업에서 생성돼 작업을 비활성화하면 공개 면에서 제외되고 파일에서 삭제되지 않습니다.

노출 워크스페이스​

노출 작업 모드는 큰 스펙을 다루도록 구축됐습니다.

  • 검색——메서드, 경로, 요약, 태그로 작업 좁히기.
  • 태그 그룹화——주 태그로 그룹, 태그 없음은 미분류.
  • 개별 전환——단일 작업 켜기/끄기.
  • 그룹 일괄——어떤 태그 그룹의 모든 작업을 한 번에 활성/비활성.
  • 전체 선택(필터됨)——전역 체크박스는 현재 검색 일치 작업에 적용.

각 작업은 한 줄이고 여러 태그가 있어도 활성 상태가 명확합니다.

실용적 기본값​

간단하고 명확한 방법은 모두 활성으로 시작해 공개 원치 않는 작업을 비활성화하는 것입니다.

  • 내부·관리 인터페이스(사용자 관리나 내부 헬스체크 등).
  • 아직 설계 중인 작업.
  • 로컬 디버그 전용 인터페이스.

선택은 파일과 독립돼 스펙 자체를 편집하지 않고 API 진화에 맞춰 바꿀 수 있습니다.

노출과 게시 상호작용​

노출은 어떤 작업이 나타나는지 정하고 다른 제어는 문서가 근본적으로 도달 가능한지 정합니다.

  • 문서는 ACTIVE여야 함.
  • 문서와 MCP에 각 활성 표시.
  • 접근은 보기 비밀번호(문서)나 접근 키(MCP)로 보호 가능.

전체 관문은 접근 통제를 보세요.

플랜 한도​

플랜은 노출 작업 수를 제한합니다.

  • Free——최대 10.
  • Pro——최대 1,000.
  • Team——최대 10,000.

관련: 접근 통제、문서와 버전.