A simple yet organized project template for building ASP.NET Core APIs using .NET Core 3.x (the latest/fastest version of .NET Core to date). The goal is to help you get up to speed when setting up the core structure of your app and its dependencies. This enables you to focus on implementing business specific requirements without you having to copy and paste the core structure of your project, and installing its dependencies all over again. This will speed up your development time when building new API project while enforcing standard project structure with its dependencies and configurations for all your apps.
If you are looking for a project template for ASP.NET Core API that you can reuse across your team, or if you are new to ASP.NET Core and would like to get up to speed on how it works without having you to configure most of the basic features that an API will have, then this is for you.
Keep in mind that you can always replace and choose whatever framework you want to use for your
API. After all, the template is just a skeleton for your project structure with default preconfigured middlewares. For example, you can always replace
Entity Framework Core,
PetaPoco, etc. and configure them yourself. You can also replace
Serilog with whatever logging frameworks and providers you want that works with
ASP.NET Core - the choice is yours.
Install the extension from the Visual Studio Marketplace
- Fire up Visual Studio 2019, click
Continue without code link.
- On the
Extensions menu, click
Online and then search for
Download. The extension is then scheduled for install.
To complete the installation, close all instances of Visual Studio.
Alternatively, you can
install the VSIX Extension directly by clicking the
Download button at the top.
Create a new Project from ApiBoilerPlate Extension
- Open Visual Studio 2019 and then select
Create New Project box
- The newly installed template should appear at the top. You can also type "
ApiBoilerPlate" in the search bar.
- Click the
ApiBoilerPlate item and then click
- Name your project to whatever you like and then click
- Visual Studio should generate the files for you.
Steps to run the template
STEP 1: Create a Test local Database:
- Open Visual Studio 2019
- Go to
SQL Server Object Explorer
- Drilldown to
SQL Server >
- Right-click "
- Click "
Add New Database"
- Name it as "
TestDB" and click OK
- Right-click on the "
TestDB" database and then select "
- Run the script below to generate the "
CREATE TABLE [dbo].[Person]
[Id] INT NOT NULL PRIMARY KEY IDENTITY(1,1),
[FirstName] NVARCHAR(20) NOT NULL,
[LastName] NVARCHAR(20) NOT NULL,
[DateOfBirth] DATETIME NOT NULL
STEP 2: Update Database ConnectionString (Optional)
If you follow step 1, then you can skip this step and run the application right away.
If you have a different
table name then you need to change the
appsettings.json that is pointing to the newly created database. You can get the
connectionString values in the
properties window of the "TestDB" database in Visual Studio.