Creating An API (Part 2)

By Ashwin Venugopal -

 




Adding The API Controller

Execute the following steps to create the API:

  • In the MyBlogWebAssembly.Server project, right-click on the Controllers folder and select Add | Class. Name the file MyBlogApiController.cs.

  •  Add a using statement at the top of the file.

  • Inherit from ControllerBase and add attributes.

  • Now we need to access the data through the server-side API. Add code inside the class we just created.

  • Next, we will add the code to get blog posts. Now, we have created a method that returns the data directly from the database.

  • Let's add the function to get the blog post count. We can use the Get verb but with another route.

  • We also need to be able to get one blog post.

  • Let's add an API that saves a blog post.

  • Next up, we add a method for deleting blog posts. In this case, we use the Delete verb, and also add the Authorize attribute.

  • Next, we need to do this for Categories and Tags as well.

We have an API! Now it's time to write the client that will access that API.

Creating The Client

In order to use the API, we must first create a client. The client will adhere to the same IMyBlogApi interface. This ensures that we maintain identical code regardless of which implementation we utilize, whether it's direct database access with MyBlogApiServerSide or the MyBlogApiClientSide that we will develop next:

  • Right-click on the Dependencies node under MyBlog.Data and select Manage NuGet Packages.

  • Search for Microsoft.AspNetCore.Components.WebAssembly.Authentication and click Install.

  • Also, search for Newtonsoft.Json and Microsoft.Extensions.Http and click Install.

  • We need some helper methods, so add a folder by right-clicking on MyBlog.Data, then Add | Folder, and name the folder Extensions.

  • Right-click on the new folder and select Add | Class. Name the class HttpClientExtensions.cs.

  • Add the following namespaces-

using Newtonsoft.Json;

using System.Net.Http;

using System.Threading;

  • Replace the class with the code.

  • Right-click on the MyBlog.Data project and select Add | Class. Name the class MyBlogApiClientSide.cs.

  • Open the newly created file.

  • Add IMyBlogApi to the class and make it public-

public class MyBlogApiClientSide:IMyBlogApi{}

  • Some of the API calls are going to be public (do not require authentication), but HttpClient will be configured to always require a token. So, we are going to need one authenticated HttpClient and one not authenticated HttpClient, depending on what API we are calling.

  • To be able to call the API, we need to inject HttpClient. Add the required code to the class.

  • We also need to add namespaces.

  • Now it's time to implement calls to the API.

  • Next, we add the API calls that need authentication, such as saving or deleting a blog post.

  • Now we need to do the same for Categories and Tags.

Our API client is now done!

Conclusion

We successfully learnt how to build an API along with an API client, which is a crucial component of many applications. By doing this, we are able to retrieve blog posts from our database and display them in our Blazor WebAssembly application.
































Comments

Post a Comment

Popular posts from this blog

How AMI Store & Restore Works?

By Ashwin Venugopal -
Image
  CreateStoreImageTask The CreateStoreImageTask API stores an AMI as a single object in an S3 bucket. The API initiates a task that collects all the data from the AMI and its associated snapshots, subsequently using an S3 multipart upload to store this data in an S3 object. It gathers all elements of the AMI, including most of the non-Region-specific metadata and all EBS snapshots included in the AMI, and consolidates them into a single object in S3. During the upload process, the data is compressed to minimize the space utilized in S3, which means that the S3 object could be smaller than the total sizes of the snapshots in the AMI. If the account making this API call has access to AMI and snapshot tags, they will be retained. The S3 object shares the same ID as the AMI, except it has a .bin extension. Additionally, the S3 metadata tags for the object include the AMI name, AMI description, AMI registration date, AMI owner account, and a timestamp indicating when the store operation...
Read more

Information Protection Scanner: Resolve Issues with Information Protection Scanner Deployment

By Ashwin Venugopal -
Image
  About If you are experiencing problems with the Microsoft Purview Information Protection scanner, check the health of your deployment by utilizing the Start-ScannerDiagnosticsPowerShell cmdlet to start the scanner diagnostic tool. The diagnostics tool checks the following details and then creates a log files with the results: Whether the database is up to date. Whether network URLs are accessible. Whether there's a valid authentication token and policy can be acquired. Whether the profile is defined in the Azure portal. Whether offline/online configuration exists and can be acquired. Whether the rules configured are valid.  The Start-ScannerDiagnostics command does not perform a comprehensive check of prerequisites. If you encounter problems with the scanner, you need to verify that your system meets the scanner's requirements, and that your scanner's configuration and installation are finished.  Verify Scanning Details Per Scanner Node and Repository Run the Get-ScanSt...
Read more

Create A Store Image Task

By Ashwin Venugopal -
Image
  Introduction When you save an AMI in an S3 bucket, a task for storing the image is initiated. This store image task allows you to track the progress and result of the procedure. Securing your AMIs It is crucial to verify that the S3 bucket is set up with adequate security to protect the content of the AMI and that this security is upheld for the entire duration that the AMI objects are stored in the bucket. If this cannot be achieved, it is advisable to refrain from using these APIs. Make sure that public access to the S3 bucket is prohibited. It is suggested to activate Server-side encryption for the S3 buckets where you keep the AMIs, even though it’s not mandatory. When AMI snapshots are transferred to the S3 object, they are sent over TLS connections. It is possible to save AMIs that contain encrypted snapshots; however, the snapshots will be decrypted during the storing process. Identify the source AMI used to create a new Amazon EC2 AMI You can determine the AMI that was us...
Read more