O designer de API

O designer de API permite-lhe projetar uma API completa diretamente no Restorm: você descreve os seus dados e as suas rotas, e o Restorm trata do resto — ele serve o seu design como um verdadeiro servidor mock, e gera o código da sua aplicação a partir de modelos.

É a ferramenta ideal para começar uma API antes de o back-end existir: maquete o contrato, faça os seus clientes testá-lo e mantenha tudo versionado no seu projeto.

Um design, várias secções

Um design cria-se como qualquer outro elemento: clique direito numa pasta ▸ Adicionar ▸ Design de API. Abre-se no seu próprio separador e agrupa várias secções, acessíveis a partir da barra lateral:

Secção	Para que serve
Modelos	As suas entidades e as suas propriedades — ver Modelos, enums e propriedades.
Enums	Conjuntos de valores fechados, reutilizáveis como tipo de propriedade.
Rotas	Os pontos de entrada da API, agrupados por recurso — ver Rotas e CRUD.
Servidor	Servir o design como um mock, em HTTP, GraphQL, SOAP, OData ou gRPC — ver Servir o design como mock.
Clientes	Pedidos prontos a usar que chamam o mock em execução — ver Clientes.
Documentação e Notas	Documentação e notas livres anexadas ao design.
Código	A geração de código a partir dos seus modelos — ver Geração de código.

Os ajustes do design (nome, valores por omissão) abrem-se clicando diretamente no nó do design na barra lateral.

O percurso típico

1. Descreva os seus dados — crie os seus modelos e os seus enums, adicione as suas propriedades, os seus tipos e as suas restrições.
2. Defina as suas rotas — à mão, ou com um clique através de Gerar o CRUD a partir de um modelo.
3. Sirva o mock — inicie o servidor e aponte a sua aplicação ou um cliente para ele. O mesmo design é projetado automaticamente em cada protocolo ativado.
4. Gere o código — escolha um ou vários modelos (os seus ou os propostos pelo Restorm) e produza o projeto correspondente.

Cada etapa é detalhada nas páginas desta secção.