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

핵심 개념

핵심 개념

이 페이지의 내용

Organization 경계#

모든 Catalog 기록은 하나의 Organization에 속합니다.

  • Web UI와 stly는 현재 선택한 Organization의 기록만 보여 주고 수정합니다.
  • 다른 Organization의 기록은 조회·검색·연결 대상이 되지 않습니다.
  • Organization을 바꾸면 목록과 검색 결과도 그 Organization의 기록으로 바뀝니다.

Organization 선택은 Web UI와 stly가 따로 관리합니다. 한쪽에서 바꿔도 다른 쪽의 선택은 그대로입니다. 자세한 내용은 Organization을 참고합니다.

ID#

Catalog 항목은 저장할 때 ID 형식의 ID를 받습니다. API·Service처럼 Organization 안에서 이름이 고유한 Catalog도 있지만, System처럼 같은 이름을 허용하는 Catalog도 있습니다. stly에서 항목을 지정하거나 연결할 때는 이름 대신 ID를 사용합니다.

stly apis list --q Orders --fields id,name

요약과 설명#

Service·API·Endpoint 같은 Catalog 항목은 요약과 설명을 따로 기록합니다.

필드용도
summary목록·표에 표시하는 한 줄 요약입니다. 최대 120자입니다.
description상세 화면에 표시하는 설명입니다. 사용 맥락·제약을 자세히 적습니다.

목록에는 요약만 표시하며 요약이 비어 있으면 빈칸으로 둡니다.

더 알아보기#