본문으로 건너뛰기
Structly 문서
English

시작하기

첫 Catalog 기록

이 페이지의 내용

인증된 Organization을 선택한 상태에서 진행합니다. 준비는 계정과 Organization 준비를 참고합니다.

Web UI에서 기록#

  1. 왼쪽 사이드바의 ORGANIZATION에서 현재 Organization을 확인합니다.
  2. CATALOG의 APIs를 누릅니다.
  3. 새 API를 누르고 이름을 입력합니다. handle에는 이름에서 만든 후보가 채워지며 주소에 쓸 값으로 고칠 수 있습니다. 요약과 설명은 선택입니다.
  4. API 등록을 누르면 목록에 새 API가 표시됩니다.

목록에는 이름과 요약이 보이고, 항목을 누르면 오른쪽 패널에서 상세를 확인·수정합니다. 요약과 설명의 차이는 핵심 개념을 참고합니다.

stly로 기록#

stly에 로그인한 뒤 실행합니다. 먼저 입력 파일 api.json을 만듭니다.

{"name": "Orders API", "handle": "orders-api", "summary": "주문 생성·조회 API", "description": "주문 Service가 제공하는 공개 API입니다."}

handle은 Web 주소에 쓰는 이름으로 같은 Organization의 API 사이에서 고유해야 합니다.

--dry-run으로 보낼 요청을 확인한 뒤 실행합니다. --dry-run은 서버에 요청하지 않습니다.

stly apis create --input api.json --dry-run
stly apis create --input api.json

성공하면 status가 201이고 data에 저장된 API가 들어 있습니다.

{"status":201,"etag":null,"location":"/api/apis/4pkKFh2ojXs","data":{"id":"4pkKFh2ojXs","handle":"orders-api","name":"Orders API","summary":"주문 생성·조회 API","description":"주문 Service가 제공하는 공개 API입니다.","base_urls":[],"created_at":"2026-10-24T15:25:12.158122Z","updated_at":"2026-10-24T15:25:12.158122Z"}}

기록 확인#

stly apis list --q Orders --fields id,name
stly apis get 4pkKFh2ojXs

apis list --q는 이름·요약·설명에서 대소문자를 구분해 찾습니다. --fields는 출력할 필드만 남깁니다. Web UI에서 기록한 API도 같은 명령으로 조회되며, stly로 기록한 API도 Web UI 목록에 표시됩니다.

다음 단계#