StackSpot.Template.Rest 1.0.1

There is a newer version of this package available.
See the version list below for details.
dotnet add package StackSpot.Template.Rest --version 1.0.1
                    
NuGet\Install-Package StackSpot.Template.Rest -Version 1.0.1
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="StackSpot.Template.Rest" Version="1.0.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="StackSpot.Template.Rest" Version="1.0.1" />
                    
Directory.Packages.props
<PackageReference Include="StackSpot.Template.Rest" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add StackSpot.Template.Rest --version 1.0.1
                    
#r "nuget: StackSpot.Template.Rest, 1.0.1"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package StackSpot.Template.Rest@1.0.1
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=StackSpot.Template.Rest&version=1.0.1
                    
Install as a Cake Addin
#tool nuget:?package=StackSpot.Template.Rest&version=1.0.1
                    
Install as a Cake Tool

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:

dotnet new stackspot.rest -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
There are no supported framework assets in this package.

Learn more about Target Frameworks and .NET Standard.

  • net6.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.