Modelos oficiais

O Restorm mantém um conjunto de modelos oficiais que pode utilizar diretamente a partir da biblioteca de modelos. Também pode partir de um deles, fazer-lhe fork e adaptá-lo às suas convenções.

O catálogo oficial

Os modelos oficiais são publicados sob a organização GitHub Monsieur-Dev:

Modelo	Alvo	Repositório
Servidor REST · TypeScript	REST · TypeScript · Express	restorm-template-server-rest-typescript
Servidor REST · .NET	REST · C# · ASP.NET Core	restorm-template-server-rest-dotnet
Servidor gRPC · TypeScript	gRPC · TypeScript	restorm-template-server-grpc-typescript
Servidor gRPC · .NET	gRPC · C# / .NET	restorm-template-server-grpc-dotnet
Base PostgreSQL	SQL · PostgreSQL	restorm-template-db-postgres

Os modelos remotos são recuperados como um arquivo (nunca clonados em git), com salvaguardas de segurança e um tamanho limitado.

Modelos de organização (Enterprise)

As organizações numa subscrição Enterprise dispõem de um catálogo de modelos privado, partilhado entre os membros da organização. Eles aparecem na biblioteca sob o separador Modelos <organização>, ao lado dos oficiais.

• Quem pode adicioná-los ou retirá-los: um administrador da organização, ou um membro a quem o admin tenha concedido o direito gerir os modelos.
• Como: a partir do separador Modelos <organização> da biblioteca (botão Adicionar — a URL do repositório e um descritivo), ou a partir do painel de administração da organização.
• O que é: um modelo de organização é um simples ponteiro para um repositório git (como um oficial); a sua estrutura é idêntica à descrita abaixo, mas a sua visibilidade está restrita aos membros da organização.

As edições Community e Pro veem os modelos oficiais e podem utilizar os seus próprios modelos (Repositório ou Pasta local) — a geração de código é livre em todas as edições. Os modelos de organização partilhados estão, por sua vez, reservados à edição Enterprise.

Estrutura de um modelo personalizado

Um modelo Restorm é um modelo Cookiecutter/Copier enriquecido com um manifesto:

• restorm-template.json — na raiz do repositório (obrigatório). Descreve o modelo e declara as variáveis que consome (ver Variáveis de geração). Anuncia também a versão de contexto que suporta: um modelo que não declara uma versão compatível com a aplicação é recusado.
• copier.yml (ou copier.yaml) — a configuração Copier, que declara nomeadamente as perguntas feitas na geração.
• Os ficheiros do modelo, sufixados em .jinja, renderizados com o contexto do design.

Para utilizar um modelo personalizado, escolha a fonte Repositório (proprietário/nome no GitHub) ou Pasta local (enquanto o desenvolve) na biblioteca.

Note

Deseja propor um modelo à comunidade? As regras de contribuição dos modelos oficiais estão documentadas no repositório da aplicação Restorm (docs/contributing).