본문으로 건너뛰기

빠른 시작

이 짧은 절차는 핵심 루프를 통과합니다. 스펙을 열고, AI 어시스턴트로 변경하고, 요청을 보내고, 결과를 문서로 확인합니다. 모두 같은 OpenAPI 문서를 사용합니다.

1. 스펙 열기​

클라이언트를 시작하고 가진 소스로 스펙을 엽니다. 다음은 모두 같은 가져오기 흐름으로 지원되며 OpenAPI 3.2로 자동 변환 또는 업그레이드됩니다.

  • 디스크의 OpenAPI 또는 Swagger 파일(Swagger 2.0, OpenAPI 3.0 / 3.1은 업그레이드).
  • Postman 컬렉션.
  • cURL 명령.
  • Git 저장소.
  • 스펙을 가리키는 URL.

파일을 워크스페이스로 직접 드래그할 수도 있습니다. 시작할 것이 없으면 짧은 설명으로 어시스턴트에게 초기 스켈레톤을 만들게 할 수 있습니다.

2. 어시스턴트에게 엔드포인트 추가 요청​

채팅에서 필요한 것을 설명합니다. 예:

제품의 페이지네이션된 목록을 반환하는 GET /products 엔드포인트를 추가해줘.

어시스턴트는 문서를 직접 편집하지 않고 패치 카드로 응답합니다. 카드에는 변경할 작업과 영향받는 경로·리소스가 표시됩니다. 검토하고 적용 또는 거부를 선택합니다. 적용하기 전에는 문서에 아무것도 도착하지 않습니다.

"이커머스 API 만들어줘" 같은 넓은 요청에서는 어시스턴트가 먼저 명확화 질문을 하고, 이후 한 번에 2~5 작업에 집중한 패치를 제안합니다.

3. 단일 작업을 흐트러짐 없이 refine​

작업을 열고 그 자리에서 refine합니다. 예를 들어 쿼리 매개변수를 추가하거나 응답 스키마를 확장합니다. 포커스 모드에서 어시스턴트는 요청한 필드에만 닿는 세밀한 패치를 생성하고 그 작업의 다른 모든 필드를 유지합니다. 이는 같은 API에서 반복 편집 시 기존 작업을 흐트러뜨리거나 덮어쓰는 것을 방지합니다.

4. 실제 요청 보내기​

작업의 요청 워크스페이스로 전환해 보냅니다. 요청은 로컬 메인 프로세스로 실행됩니다. 응답, 상태, 헤더, 타이밍이 작업과 나란히 표시되고 실행마다 바뀌는 값에는 환경과 변수를 사용할 수 있습니다.

스펙의 servers와 활성 환경 모두에 베이스 URL이 없어 요청을 구성할 수 없으면 앱은 추측하지 않고 베이스 URL 입력을 요청합니다.

5. 문서 확인​

문서를 열면 같은 스펙이 읽기 쉬운 API 문서로 렌더링됩니다. 뷰어는 라이브 문서를 읽으므로 문서는 지금 설계한 내용과 항상 일치합니다.

6. 준비되면 더 진행​

이것으로 핵심 루프가 완료됩니다. 나머지 문서에서 각 워크스페이스를 자세히 설명합니다.