StackSpot.Template.Rest 1.0.3

StackSpot Template Rest

Componente projetado para auxiliar no desenvolvimento de serviços Rest

Para saber mais sobre templates, acesse a documentação da microsoft.

Instalação

Para realizar a instalação do Scaffold em .NET, execute comando abaixo:

dotnet new -i StackSpot.Template.Rest::*

Caso a instalação do Scaffold tenha sido realizada com sucesso, será listado o template na lista de tipos de projetos, que podem ser criados no terminal.

Também é possível listar os templates existentes através do comando abaixo:

dotnet new

Uso

Para criar um projeto, acesse o diretório no qual deseja criar o projeto e execute o comando a seguir:

• net6.0

dotnet new stackspot.rest -n Example -p example-api -o .

• net5.0

dotnet new stackspot.rest.net5 -n Example -p example-api -o .

Nota: Lembre-se de alterar o nome do projeto e o repositório para serem aderentes ao domínio de seu serviço.

Alguns parâmetros desse comando são:

• Nome da solução: -n
• Nome do repositório git: -p
• Criar o projeto no diretório atual: -o .

Execução do projeto criado

Após criar o projeto, acesse o diretório src e execute o seguinte comando:

dotnet restore

Realize também o build do projeto, através do comando abaixo:

dotnet build

Para testar a aplicação, acesse o diretório que contém o projeto da api. Neste exemplo, o diretório é o Example.Api. Dentro deste diretório, execute o seguinte comando:

dotnet run

Com a aplicação em execução, acesse a url https://localhost:5001/swagger, acesse os detalhes da aplicação e clique em "Ir para localhost (não seguro)". Ao acessar o endereço acima, você poderá ver a documentação de sua aplicação.

Dica: Neste caso, a estrutura com exemplo foi criada automaticamente.

Desenvolvimento

Se durante o desenvolvimento do template for necessário instalar a partir do source, basta executar o comando abaixo na raiz do projeto:

dotnet new -i content/Template