API 디자이너

API 디자이너 를 사용하면 완전한 API를 Restorm 안에서 직접 설계할 수 있습니다. 데이터와 라우트를 기술하면 나머지는 Restorm이 처리합니다. 설계를 실제 목 서버처럼 제공 하고, 템플릿을 바탕으로 애플리케이션 코드를 생성 합니다.

백엔드가 아직 존재하지 않는 단계에서 API를 시작하기에 이상적인 도구입니다. 계약을 목으로 구성하고, 클라이언트에게 테스트하게 하며, 그 모든 것을 프로젝트 안에서 버전 관리된 상태로 유지합니다.

하나의 설계, 여러 섹션

설계는 다른 요소와 마찬가지로 생성합니다. 폴더 우클릭 ▸ 추가 ▸ API 설계. 전용 탭에서 열리며, 사이드바에서 접근할 수 있는 여러 섹션을 묶고 있습니다.

섹션	용도
모델	엔티티와 그 속성 — 모델, enum, 속성 참조.
Enum	속성 타입으로 재사용할 수 있는 닫힌 값 집합.
라우트	리소스별로 묶인 API의 진입점 — 라우트 & CRUD 참조.
서버	설계를 HTTP, GraphQL, SOAP, OData, gRPC 목으로 제공 — 설계를 목으로 제공하기 참조.
클라이언트	실행 중인 목을 호출하는, 바로 사용할 수 있는 요청 — 클라이언트 참조.
문서 및 메모	설계에 첨부된 자유로운 문서와 메모.
코드	자신의 템플릿으로부터의 코드 생성 — 코드 생성 참조.

설계의 설정(이름, 기본값)은 사이드바의 설계 노드를 직접 클릭하면 열립니다.

일반적인 흐름

1. 데이터를 기술합니다 — 모델과 enum을 만들고, 그 속성, 타입, 제약을 추가합니다.
2. 라우트를 정의합니다 — 직접, 또는 모델에서 CRUD 생성 으로 한 번의 클릭으로.
3. 목을 제공합니다 — 서버를 시작하고 애플리케이션이나 클라이언트를 거기에 연결합니다. 동일한 설계가 활성화된 각 프로토콜로 자동으로 투영됩니다.
4. 코드를 생성합니다 — 하나 이상의 템플릿(자신의 것 또는 Restorm이 제공하는 것)을 선택하고 그에 해당하는 프로젝트를 생성합니다.

각 단계는 이 섹션의 각 페이지에서 자세히 설명합니다.