가이드 목록#
| 가이드 | 다루는 내용 |
|---|---|
| Service | Service와 제공 API·Repository 연결 |
| API | API와 Base URL, 제공 Service |
| Endpoint | Method·Path, Parameter·Request Body·Response의 Schema와 예제 |
| Database | engine별 Database와 Table·Collection·Key Pattern |
| Repository | Repository와 OpenAPI·AsyncAPI·Arazzo 스펙 문서 |
| OpenAPI 동기화 | OpenAPI 문서 등록과 API·Endpoint 반영 승인 |
| Messaging | Kafka Cluster·Topic·Message Definition·사용 설명 |
| Workflow | Endpoint·Workflow를 호출하는 Step |
| System | Service·API·System 구성 |
| 통합 검색 | 여러 Catalog를 한 번에 찾기 |
Web UI의 공통 순서#
- 사이드바 CATALOG에서 메뉴를 고릅니다. 메뉴 이름은 Catalog 종류와 연결의 표를 참고합니다.
- 새 … 버튼(예: 새 Service)으로 입력 패널을 열고 … 등록(예: Service 등록)으로 저장합니다. 최상위 Catalog는 이름 아래의 handle도 입력합니다(주소 이름).
- 목록에서 항목을 누르면 상세 패널이 열립니다. 수정으로 편집하고 변경 저장으로 저장합니다.
- 삭제는 상세의 삭제를 누른 뒤 삭제 확인으로 진행합니다.
다른 사람이 먼저 저장했으면 저장이 거부되고 입력은 유지됩니다. 처리 방법은 동시 수정 충돌을 참고합니다.
stly의 공통 명령#
리소스 이름은 Catalog마다 다르지만 명령 형식은 같습니다.
stly services list --q orders
stly services get <id>
stly services create --input service.json
stly services update <id> --input service.json --if-match '"상세 조회의 ETag"'
stly services delete <id> --if-match '"상세 조회의 ETag"'- 입력 형식은
stly schema <resource> <action>의request_schema에서 확인합니다. - 최상위 Catalog의
create입력에는handle이 필수입니다.update에서 생략하면 저장된 값을 유지합니다. - 목록은
--handle로 handle이 같은 항목만 찾고(예:stly services list --handle orders-service),stly catalog check-handle orders-service --catalog services처럼 사용 가능 여부를 미리 확인합니다. - Endpoint·Database·Table·Key Pattern·Kafka Cluster·Topic·Workflow는 저장 없이 입력을 검사하는
validate를 제공합니다.
stly endpoints validate --operation create --input endpoint.json검사를 통과하면 data.valid가 true입니다. 입력에 문제가 있으면 HTTP 422 VALIDATION_FAILED와 함께 문제가 된 필드를 error.data에 반환합니다.