Blip.Api.Template 2.0.2.2

BLiP.API.Template

This template aims to kickstart the development of an API to be used alongside BLiP's Builder feature

Installation

If you already have dotnet installed, you can install this template with the command

dotnet new -i Blip.Api.Template

If you don't have dotnet installed, follow these instructions from Microsoft to install it on GNU/Linux, Mac or Windows, and then use the command above.

Usage

To create a new project using this template, after installing, type in the following command

dotnet new blip-api

Your new project should be created in the open folder.

Renaming the Services project

By default, when you create a new solution using the template, all .csproj files will use the name of the folder you're in (along with any mentions of Blip.Api.Template. You can give the Services project a different name should you like it using the CLI param --Services.

For example, if you run the command

dotnet new blip-api --Services DifferentName.Services

inside a folder named Blip.Bot.Project, it will create a .sln with two projects: Blip.Bot.Project.csproj and DifferentName.Services.csproj, instead of a Blip.Bot.Project.Services.csproj.

File Structure

    📁src
    |__📁Blip.Api.Template // The Web API project Folder
    |   |__📁Controllers
    |   |   |__📃{YourControllers.cs}
    |   |   |__📃{...}
    |   |__📁Models
    |   |   |__📃{YourModelClasses.cs}
    |   |   |__📃{...}
    |   |__📁Services
    |   |   |__📃{YourServicesAndInterfaces.cs}
    |   |__📃MySettings.cs
    |   |__📃Startup.cs
    |   |__📃appsettings.json
    |__📁Blip.Api.Template.Services // (If needed) The project to use for 3rd party APIs to be consumed
    |   |__{Recommended to follow similar structure from the above project}
    |__⚙️.editorconfig

Uninstallation

To uninstall the template from your local machine, use the command

dotnet new -u Blip.Api.Template

Your current projects that already use the template will not be affected.

Feature Roadmap

• Basic controller for external link tracking