This library contains an opinionated templated ASP.NET Core WebApi project. The template package is available on NuGet, which will allow new API's/microservices to be easily created via the CLI (command line interface) dotnet new tool/command.
This library heavily leverages our other helpers library.
- Install the template using the command line (we do this once, only):
dotnet new -i Homely.AspNetCore.WebApi.Template
- Create a new project using the template (we do this every time we're creating a new web api):
dotnet new homelyapi -n YourOrg.YourServiceName.WebApi
Optional settings:
| Argument | Description | Default Value | Sample Value |
|---|---|---|---|
swagger-title |
Title for the Docs | "My API" |
"Awesome API" |
swagger-version |
API Version | v1 |
v2 |
swagger-routeprefix |
Root route to access the swagger docs | "swagger" |
"accounts/swagger " |
The new API template will be created with the namespace specified in the -n parameter.
- The template.json file configures how the template will be created.
- Note the
sourceNameproperty in that file with the valueHomely.ProjectName.WebApi. This is the default namespace for all the.csfiles, which is replaced by the value in the-nparameter. - The nuspec dictates this package is a special "template" file, via the
<packageType name="Template">directive. More info about templates: https://docs.microsoft.com/en-us/dotnet/core/tools/custom-templates
- Based off an Empty ASPNET Core 2.2 Web App.
- Uses
ProblemDetailsfor consistent error models [Shoutout to @khellang Middleware library] - Default
HomeControllerwith default route "/". (You can optionally provide a nice text message / banner :) ) - Common JSON settings. (e.g. Camel casing, indenting, etc.)
- Serilog for logging (
Developmentmode logs toConsole). Check here to use other sinks. - Swagger and SwaggerUI (via Swashbuckle Framework) for API documentation.
These default opinionated features were mostly derived from these projects:
- Homely - ASP.NET Core 'Hosting' core application-library - an opinioned program.cs class which is to reduce the ceremony for creating ASP.NET Core "Web Hosting" applications.
- Homely - ASP.NET Core MVC Helpers - Some helper methods, models and extensions for an ASP.NET Core MVC application.
Discussions and pull requests are encouraged :) Please ask all general questions in this repo or pick a specialized repo for specific, targetted issues. We also have a contributing document which goes into detail about how to do this.
Yep, we also have a code of conduct which applies to all repositories in the (GitHub) Homely organisation.
Yep, refer to the contributing page about how best to give feedback - either good or needs-improvement :)