52
loading...
Building REST APIs In .Net 6 The Easy Way!
the goal of this article is to introduce you to an alternative, more developer friendly way of bulding web apis with asp.net 6 instead of the more commonly used mvc controllers.
we will be exploring the open source endpoint library FastEndpoints which is built on top of the new minimal api in .net 6, where we can get all the performance benefits without the pain-points of minimal api. the resulting code-base is cleaner to navigate and project maintainability becomes a breeze when combined with vertical slice architecture, no matter the size or complexity of the project, because the framework stays out of your way so you can focus on the engineering & functional aspects of your systems.
let's get our hands dirty by building a rest api for a simplified version of dev.to where authors/posters can sign up for an account and publish articles. new articles will go into a moderation queue where the site administrator would have to approve it before being publicly available.
the main entities in our system would be the following:
the features/user stories of our system could be classified as follows:
- login to site
- get a list articles to be moderated
- approve an article to publish it
- reject an article with a reason
- sign up on site
- login to site
- get a list of their own articles
- see status [pending/approved/rejected]
- create new article
- edit existing article
- get a list of 50 latest articles
- get article by id
- get latest 50 comments for an article
- post a comment on an article
the tech stack used will be the following:
create a new web project and install the dependencies either using visual studio or by running the following commands in a terminal window:
dotnet new web -n MiniDevTo
dotnet add package FastEndpoints
dotnet add package FastEndpoints.Swagger
dotnet add package MongoDB.Entitiescreate the folder structure for our features so that it looks like the following:
each last level of the tree is going to be a single endpoint which could either be a command or a query which the ui/frontend of our app can call. queries are prefixed with
Get as a convention indicating it is a retrieval of data, whereas commands are prefixed with verbs such as Save, Approve, Reject, etc. indicating committing of some state change. this might sound familiar if you've come across CQRS before, but we're not separating reads vs. writes here as done in CQRS. instead, we're organizing our our features/endpoints in accordance with Vertical Slice Architecter.FastEndpoints is an implementation of REPR pattern. (this will be the last pattern i'll talk about in this article, i promise!)
The REPR Design Pattern defines web API endpoints as having three components: a Request, an Endpoint, and a Response. It simplifies the frequently-used MVC pattern and is more focused on API development.
so, in order to give us some relief of the boring, repetitive task of creating the multiple class files needed for an endpoint, go ahead and install this visual studio extension provided by FastEndpoints. no worries if you're not using visual studio, you can create those files manually.
first thing's first... let's update
Program.cs file to look like the following:global using FastEndpoints;
global using FastEndpoints.Validation;
var builder = WebApplication.CreateBuilder();
builder.Services.AddFastEndpoints();
var app = builder.Build();
app.UseAuthorization();
app.UseFastEndpoints();
app.Run();this is all that's needed for this to be a web api project. but... if you try to run the program now, you will be greeted with a run-time exception such as the following:
InvalidOperationException: 'FastEndpoints was unable to find any endpoint declarations!'
let's fix that by creating our very first endpoint using the vs extension we just installed.
right-click the
Author/Signup folder in visual studio > add > new item. then select FastEndpoints Feature FileSet new item template located under the Installed > Visual C# node. then for the file name, enter Author.Signup.cs as shown below:
what that will do is, it'll create a new set of files under the folder you selected with a namespace specific for this endpoint. open up
Endpoint.cs file and have a look at the namespace at the top. it is what we typed in as the file name earlier.while we have the endpoint class opened, go ahead and replace it's contents with the code below:
namespace Author.Signup;
public class Endpoint : Endpoint<Request, Response, Mapper>
{
public override void Configure()
{
Verbs(Http.POST);
Routes("/author/signup");
AllowAnonymous();
}
public override async Task HandleAsync(Request r, CancellationToken c)
{
await SendAsync(new Response()
{
//blank for now
});
}
}what do we have here? we have an endpoint class definition that inherits from the generic base class
Endpoint<TRequest, TResponse, TMapper>. it has 2 overridden methods Configure() and HandleAsync().in the configure method, we're specifying that we want the endpoint to listen for the http verb/method
post on the route /author/signup. we're also saying that unauthenticated users should be allowed to access this endpoint by using the AllowAnonymous() method. the
HandleAsync() method is where you'd write the logic for handling the incoming request. for now it's just sending a blank response because we haven't yet added any fields/properties to our request & response dto classes.open up the
Models.cs file and replace request and response classes with the following:public class Request
{
public string FirstName { get; set; }
public string LastName { get; set; }
public string Email { get; set; }
public string UserName { get; set; }
public string Password { get; set; }
}
public class Response
{
public string Message { get; set; }
}now, let's setup swagger so we have a way to interact with our endpoints using a web browser as opposed to using something like postman. open up
Program.cs again and make it look like this:global using FastEndpoints;
global using FastEndpoints.Validation;
using FastEndpoints.Swagger; //add this
var builder = WebApplication.CreateBuilder();
builder.Services.AddFastEndpoints();
builder.Services.AddSwagger(); //add this
var app = builder.Build();
app.UseAuthorization();
app.UseFastEndpoints();
app.UseSwagger(); //add this
app.UseSwaggerUI(); //add this
app.Run();then open up
Properties/launchSettings.json file and replace contents with this:{
"profiles": {
"MiniDevTo": {
"commandName": "Project",
"dotnetRunMessages": true,
"launchBrowser": false,
"applicationUrl": "http://localhost:8080",
"environmentVariables": {
"ASPNETCORE_ENVIRONMENT": "Development"
}
}
}
}updating launch settings is not mandatory but let's fix the listening port of our api server to
8080 for the purpose of this article.next build and run your project in debug mode (CTRL+F5 in visual studio). fire up your web browser and head on over to the url
http://localhost:8080/swagger to see the swagger ui.you should now be seeing something like this:
expand the
/author/signup endpoint, and modify the request body/json to look like this (click Try It Out button to do so):{
"FirstName": "Johnny",
"LastName": "Lawrence",
"Email": "[email protected]",
"UserName": "EagleFang",
"Password": "death2kobra"
}before executing the request, head on over to the
Endpoint.cs file and place a breakpoint on line 14. then go ahead and hit the execute button in swagger. once the breakpoint is hit, inspect the request dto parameter of the HandleAsync() method where you will see something like this:
that is basically how you receive a request from a client (swagger-ui in this case). the handler method is supplied with a fully populated poco from the incoming http request. for a detailed explanation of how this model binding works, please have a look at the documentation page here.
let's return a response from our endpoint now. stop debugging and update the
HandleAsync() method to look like the following:public override async Task HandleAsync(Request r, CancellationToken c)
{
await SendAsync(new Response()
{
Message = $"hello {r.FirstName} {r.LastName}! your request has been received!"
});
}start the app again and execute the same request in swagger. which should display the response from the server as follows:
there are multiple ways to send responses back to the client from a handler. here we're sending a new instance of a response dto populated with a custom message.
open the
Models.cs file and make the validator class look like the following:public class Validator : Validator<Request>
{
public Validator()
{
RuleFor(x => x.FirstName)
.NotEmpty().WithMessage("your name is required!")
.MinimumLength(3).WithMessage("name is too short!")
.MaximumLength(25).WithMessage("name is too long!");
RuleFor(x => x.Email)
.NotEmpty().WithMessage("email address is required!")
.EmailAddress().WithMessage("the format of your email address is wrong!");
RuleFor(x => x.UserName)
.NotEmpty().WithMessage("a username is required!")
.MinimumLength(3).WithMessage("username is too short!")
.MaximumLength(15).WithMessage("username is too long!");
RuleFor(x => x.Password)
.NotEmpty().WithMessage("a password is required!")
.MinimumLength(10).WithMessage("password is too short!")
.MaximumLength(25).WithMessage("password is too long!");
}
}here we're defining the input validation requirements using fluent validation rules. let's see what happens when the user input doesn't meet the above criteria. execute the same request in swagger with the following incorrect json content:
{
"LastName": "Lawrence",
"Email": "what is email?",
"UserName": "EagleFang",
"Password": "123"
}the server will respond with this:
{
"StatusCode": 400,
"Message": "One or more errors occured!",
"Errors": {
"FirstName": [ "your name is required!" ],
"Email": [ "the format of your email address is wrong!" ],
"Password": ["password is too short!" ]
}
}as you can see, if the incoming request data does not meet the validation criteria, a
http 400 bad response is returned with the details of what is wrong. the handler logic will not be executed in case there is a validation error in the incoming request. this default behavior can be changed like this if need be.let's go ahead and persists a new
Author entity to the database by modifying the handler logic.public override async Task HandleAsync(Request r, CancellationToken c)
{
var author = Map.ToEntity(r);
var emailIsTaken = await Data.EmailAddressIsTaken(author.Email);
if (emailIsTaken)
AddError(r => r.Email, "sorry! email address is already in use...");
var userNameIsTaken = await Data.UserNameIsTaken(author.UserName);
if (userNameIsTaken)
AddError(r => r.UserName, "sorry! that username is not available...");
ThrowIfAnyErrors();
await Data.CreateNewAuthor(author);
await SendAsync(new()
{
Message = "Thank you for signing up as an author!"
});
}first, we're using the
ToEntity() method on the Map property of the endpoint class to transform the request dto into an Author domain entity. the logic for mapping is in the Mapper.cs file which can be found here. you can read more about the mapper class here.then we're asking the database if this email address is already taken by someone. code here. if it's already taken we're adding a validation error to the collection of errors of the endpoint using the
AddError() method.next, we're asking the db if the username is already taken by someone and add an error if it's taken.
after all the business rules are checked, we want to send an error response to the client if any of the previous business rule checks have failed. that's what the
ThrowIfAnyErrors() does. when either the username or email address is taken, a response like the following will be sent to the client. execution is stopped at that point and the proceeding lines of code are not executed.{
"StatusCode": 400,
"Message": "One or more errors occured!",
"Errors": {
"Email": [ "sorry! email address is already in use." ],
"UserName": [ "sorry! that username is not available." ]
}
}if there are no validation errors added, and author creation worked, the following json response will be received by the client.
{
"Message": "Thank you for signing up as an author!"
}you've persevered thus far and have your first working endpoint. if you're interested in completing this exercise, head on over to github and have a look through the full source code. things should now be self explanatory. if something is unclear, please comment here or open a github issue. i will try my best to answer within 24hrs. also have a look through the following resources which will explain most of the code.
52