아래 예제는 로그인하고 Organization을 선택한 상태를 전제로 합니다. ID는 실제 결과의 값으로 바꿉니다.
목록 조회와 검색#
stly apis list --fields id,name,summary
stly apis list --q Orders --page 1 --per-page 50--q를 지원하는 목록은 이름·요약·설명 같은 필드에서 대소문자를 구분해 부분 일치로 찾습니다. 검색 대상 필드는 명령마다 다르므로 stly schema <resource> list에서 확인합니다.
--page·--per-page를 지정하면 응답에 pagination(page·per_page·has_more)이 추가됩니다.
여러 Catalog를 한 번에 찾을 때는 통합 검색을 사용합니다.
stly catalog search --q 주문생성#
명령을 모를 때는 검색 → 스키마 → dry-run → 실행 순서로 진행합니다.
stly cli search "API 생성"
stly schema apis create
stly apis create --input api.json --dry-run
stly apis create --input api.json수정#
수정은 입력 전체를 보내는 방식입니다. 상세를 조회해 현재 값과 etag를 확인하고, 바꿀 값을 반영한 입력 파일을 만듭니다.
stly apis get 4pkKFh2ojXs
stly apis update 4pkKFh2ojXs --input api-update.json --if-match '"api-json3-4pkKFh2ojXs-r1"'api-update.json 예:
{"name": "Orders API", "summary": "주문 생성·조회·취소 API", "description": "주문 Service가 제공하는 공개 API입니다."}412 오류가 나면 동시 수정 충돌의 순서로 처리합니다.
삭제#
삭제에도 상세 조회의 etag가 필요합니다. 성공하면 status가 204이고 data는 null입니다.
stly apis delete 4pkKFh2ojXs --if-match '"api-json3-4pkKFh2ojXs-r2"'직접 API 호출#
전용 명령이 없는 요청은 stly api로 공개 API 경로를 직접 호출합니다. 인증은 다른 명령과 같은 방식을 사용합니다.
stly api /api/me --method GET
stly api /api/apis --method GET--input으로 요청 본문을, --if-match로 ETag를 함께 보낼 수 있습니다. 출력 형식은 다른 명령과 같습니다.
AI Coding Agent에서 사용#
AI Coding Agent에게는 다음 규칙을 알려 주면 stly를 안전하게 사용할 수 있습니다.
- 명령은
stly cli search로 찾고 입력은stly schema로 확인합니다. - 기록을 바꾸는 명령은 먼저
--dry-run으로 확인합니다. - 수정·삭제 전에는 상세를 조회해
etag를--if-match로 전달합니다. - 종료 코드와 stderr의
outcome을 확인하고,unknown이면 다시 보내기 전에 조회합니다.