Herald.Template.WebApi

Overview

• Herald Scaffold for create WebAPI projects.

Installation

• .NET CLI

  dotnet new -i Herald.Template.WebAPI::*
  

See more information in Nuget.

Usage

dotnet new herald-api -n ProjectName -o OutputFolder

Full Options

dotnet new herald-api -n ProjectName -o OutputFolder -f=net6.0 -q=sqs -d=postgre -ne

  -n|--name             The project and solution name for the output being created.
                        string - Optional
                        Default: current folder
  
  -o|--output           Location to place the generated output.
                        string - Optional
                        Default: current folder

  -f|--framework        The target framework for the project.
                            net6.0           - .NET 6.0
                            net5.0           - .NET 5.0
                            netcoreapp3.1    - .NET Core 3.1
                        Default: net6.0

  -q|--queue            Includes/removes the queue sample into generated project.
                            none        - No queue
                            sqs         - Amazon SQS
                            kafka       - Apache Kafka
                            rabbitmq    - RabbitMQ
                            azure       - Azure Queue Storage
                        Default: sqs

  -d|--database         Includes/removes the database sample into generated project.
                            none         - No database
                            postgre      - PostgreSQL
                            mysql        - MySQL
                            sqlserver    - Microsoft SQL Server
                        Default: postgre

  -ne|--no-externalapi  Removes external api sample into generated project.
                        bool - Optional
                        Default: false

Credits

Author Thiago Fialho

License

Herald.Template.WebApi is licensed under the MIT License.