Skip to main content

Part-4 | .NET 6 Web API | SQL Database | React JS(v18) | CRUD Example

The main objectives of this article are:
  • Create an API endpoint to fetch all records
  • Create ReactJS component to display all records

Create 'SuperVillain' Controller In API Project:

A Controller is an entity or class that contains logical methods or function that gets executed for an HTTP request from the clients.

Let's create a controller 'SuperVillianController.cs'.
API_Project/Controllers/SuperVillianController.cs:
using Microsoft.AspNetCore.Mvc;
using ReactDemo.API.Data;

namespace ReactDemo.API.Controllers;

[ApiController]
[Route("[controller]")]
public class SuperVillainController : ControllerBase
{
    private readonly ReactJSDemoContext _reactJSDemoContext;
    public SuperVillainController(ReactJSDemoContext reactJSDemoContext)
    {
        _reactJSDemoContext = reactJSDemoContext;
    }
}
  • (Line: 6) The 'ApiController' attribute applies all API rules to the controller.
  • (Line: 7) The 'Route("[controller]")' attribute enables the attribute routing for controller. The '[controller]' expression represents the name of the controller that will be part of the URL.
  • (Line: 8) To make our 'SuperVillainController' class an API controller it should inherit the 'Controller Base'.
  • (Line: 10-14) Injected our database context into our controller constructor.

Create Get Endpoint Action Method In API Project:

In an API action method, the logic unit gets executed for the HTTP request and also serves the response to the users.

Let's create an action method to implement the read operation(fetching data).
API_Project/Controllers/SuperVillainController.cs:
using Microsoft.EntityFrameworkCore;

[HttpGet]
public async Task<IActionResult> Get()
{
	var villains = await _reactJSDemoContext.SuperVillain.ToListAsync();
	return Ok(villains);
}
  • (Line: 3) The 'HttpGet' attribute enables our action method needs to be invoked only for HTTP request
  • (Line: 6) The 'ToListAsync()' method fetches all records from the database asynchronously.
  • (Line: 7) The 'Ok()' method return the success response.
To test our endpoint, let's insert some data into the database and then run our API project and check the swagger output.

Create A 'AllSuperVillain' React Component In React Application:

Let's create a react component like 'AllSuperVillain.js' inside of a new folder called 'pages'.
React_App/src/pages/AllSuperVillain.js:
function AllSuperVillain() {
  return <></>;
}
export default AllSuperVillain;

Install Axios Library In To React Application:

To invoke the HTTP API calls one of the best-recommended third-party libraries is Axios.
npm i axios

Consume API From 'AllSuperVillain' React Component:

Let's try to consume the API and then render the response in the 'AllSuperVillain' component.
React_App/src/pages/AllSuperVillain.js:
import { Row } from "react-bootstrap";
import Card from "react-bootstrap/Card";
import Col from "react-bootstrap/Col";
import { useEffect, useState } from "react";
import axios from "axios";

function AllSuperVillain() {
  const [superVillains, setSuperVillains] = useState([]);

  useEffect(() => {
    axios.get("https://localhost:7273/SuperVillain").then((response) => {
      setSuperVillains((data) => {
        return response.data;
      });
    });
  }, []);

  return (
    <>
      <Row md={3} className="g-4 mt-1">
        {superVillains.map((sv) => {
          return (
            <Col key={sv.id}>
              <Card>
                <Card.Img variant="top" src={sv.imageUrl} />
                <Card.Body>
                  <Card.Title>{sv.villainName}</Card.Title>
                  <Card.Text>
                    <b>Franchis:</b> {sv.franchise}
                  </Card.Text>
                  <Card.Text>
                    <b>Powers: </b>
                    {sv.powers}
                  </Card.Text>
                </Card.Body>
              </Card>
            </Col>
          );
        })}
      </Row>
    </>
  );
}

export default AllSuperVillain;
  • The 'useState' loads from the 'react' library. In react js application to maintain a state of data we will use the 'useState'. If the value of 'useState' variable changes entire component gets refreshed. The default value can be given while it is initialized. The 'useState' return array of 2 values, where the first value will be the data and the second value will be the function to update the state. 
  • The 'useEffect' loads from the 'react' library. The 'useEffect(()=> {},[])' contains 2 in parameters where first parameter is arrow function in which we can write logic to executes and second parameter is array to which we can pass 'useState' values. So whenever the second parameter value changes then only the 'useEffect' gets executed. If the second parameter array is empty then the 'useEffect' get executes only once.
  • (Line: 8) Declared the 'useState' where its value will be accessed through 'superVillians' and to update it we have to use the 'setSuperVillains' function.
  • (Line: 10-16) Here used the 'useEffect' where we implemented our Axios API call logic. So to execute the logic inside of 'useEffect' only once we passed the second parameter as an empty array.
  • (Line: 20) Used react js bootstrap 'Row' component and specified its property like 'md={3}' only render 3 columns from medium size screens.
  • (Line: 21) The 'superVillians' state variable which contains API response is looping to render the data.
  • (Line: 23) The 'Col' component specified the 'key' property which is recommended to provide unique value for looping items.
  • (Line: 23-33) In react js to render dynamic data we have to using single flower brace '{}'
Now let's add the 'AllSuperVillains' component to the 'App' component.
React_App/src/App.js:
import logo from './logo.svg';
import './App.css';
import Layout from './components/shared/Layout';
import AllSuperVillain from './pages/AllSuperVillain';

function App() {
  return (
    <Layout>
      <AllSuperVillain></AllSuperVillain>
    </Layout>
  );
}

export default App;
  • Here are 'AllSuperVillain' component element renders inside of the 'Layout' component element
Now run our both ReactJs application and API application and check the output. We can observe the API gets failed due to the 'CORS' issue which happens due to both applications running on different ports.

Enable Cors Service In API Project:

In our API application, we have to allow our ReactJS domain to consume the API. For that, we have to enable the Cors policy.
In the 'Program.cs' file let's register the 'CORS' service as below.
API_Project/Progrm.cs:
  • Here we added 'CORS' policy to give access to our react js application to consume the API.
The 'Program.cs' file lets the register the 'CORS' middleware as below
Now check our React Js application and we can observe API is able to consume by our react app.
In the next article, we are going to implement the create operation.

Support Me!
Buy Me A Coffee PayPal Me

Video Session:

Wrapping up:

Hopefully, I think this article delivered some useful information on the .NET 6 Web API and React JS(v18). using I love to have your feedback, suggestions, and better techniques in the comment section below.

Refer:


Follow Me:

Comments

Popular posts from this blog

Angular 14 Reactive Forms Example

In this article, we will explore the Angular(14) reactive forms with an example. Reactive Forms: Angular reactive forms support model-driven techniques to handle the form's input values. The reactive forms state is immutable, any form filed change creates a new state for the form. Reactive forms are built around observable streams, where form inputs and values are provided as streams of input values, which can be accessed synchronously. Some key notations that involve in reactive forms are like: FormControl - each input element in the form is 'FormControl'. The 'FormControl' tracks the value and validation status of form fields. FormGroup - Track the value and validate the state of the group of 'FormControl'. FormBuilder - Angular service which can be used to create the 'FormGroup' or FormControl instance quickly. Form Array - That can hold infinite form control, this helps to create dynamic forms. Create An Angular(14) Application: Let'

.NET 7 Web API CRUD Using Entity Framework Core

In this article, we are going to implement a sample .NET 7 Web API CRUD using the Entity Framework Core. Web API: Web API is a framework for building HTTP services that can be accessed from any client like browser, mobile devices, and desktop apps. In simple terminology API(Application Programming Interface) means an interface module that contains programming functions that can be requested via HTTP calls either to fetch or update data for their respective clients. Some of the Key Characteristics of API: Supports HTTP verbs like 'GET', 'POST', 'PUT', 'DELETE', etc. Supports default responses like 'XML' and 'JSON'. Also can define custom responses. Supports self-hosting or individual hosting, so that all different kinds of apps can consume it. Authentication and Authorization are easy to implement. The ideal platform to build the REST full services. Install The SQL Server And SQL Management Studio: Let's install the SQL server on our l

ReactJS(v18) JWT Authentication Using HTTP Only Cookie

In this article, we will implement the ReactJS application authentication using the HTTP-only cookie. HTTP Only Cookie: In a SPA(Single Page Application) Authentication JWT token either can be stored in browser 'LocalStorage' or in 'Cookie'. Storing the JWT token inside of the cookie then the cookie should be HTTP Only. The HTTP-ONly cookie nature is that it will be only accessible by the server application. Client apps like javascript-based apps can't access the HTTP-Only cookie. So if we use the authentication with HTTP-only JWT cookie then we no need to implement the custom logic like adding authorization header or storing token data, etc at our client application. Because once the user authenticated cookie will be automatically sent to the server by the browser on every API call. Authentication API: To authenticate our client application with JWT HTTP-only cookie, I developed a NetJS(which is a node) Mock API. Check the GitHub link and read the document on G

.NET6 Web API CRUD Operation With Entity Framework Core

In this article, we are going to do a small demo on AspNetCore 6 Web API CRUD operations. What Is Web API: Web API is a framework for building HTTP services that can be accessed from any client like browser, mobile devices, desktop apps. In simple terminology API(Application Programming Interface) means an interface module that contains a programming function that can be requested via HTTP calls to save or fetch the data for their respective clients. Some of the key characteristics of API: Supports HTTP verbs like 'GET', 'POST', 'PUT', 'DELETE', etc. Supports default responses like 'XML' and 'JSON'. Also can define custom responses. Supports self-hosting or individual hosting, so that all different kinds of apps can consume it. Authentication and Authorization are easy to implement. The ideal platform to build REST full services. Create A .NET6 Web API Application: Let's create a .Net6 Web API sample application to accomplish our

Angular 14 State Management CRUD Example With NgRx(14)

In this article, we are going to implement the Angular(14) state management CRUD example with NgRx(14) NgRx Store For State Management: In an angular application to share consistent data between multiple components, we use NgRx state management. Using NgRx state helps to avoid unwanted API calls, easy to maintain consistent data, etc. The main building blocks for the NgRx store are: Actions - NgRx actions represents event to trigger the reducers to save the data into the stores. Reducer - Reducer's pure function, which is used to create a new state on data change. Store - The store is the model or entity that holds the data. Selector - Selector to fetch the slices of data from the store to angular components. Effects - Effects deals with external network calls like API. The effect gets executed based the action performed Ngrx State Management flow: The angular component needs data for binding.  So angular component calls an action that is responsible for invoking the API call.  Aft

Angular 14 Crud Example

In this article, we will implement CRUD operation in the Angular 14 application. Angular: Angular is a framework that can be used to build a single-page application. Angular applications are built with components that make our code simple and clean. Angular components compose of 3 files like TypeScript File(*.ts), Html File(*.html), CSS File(*.cs) Components typescript file and HTML file support 2-way binding which means data flow is bi-directional Component typescript file listens for all HTML events from the HTML file. Create Angular(14) Application: Let's create an Angular(14) application to begin our sample. Make sure to install the Angular CLI tool into our local machine because it provides easy CLI commands to play with the angular application. Command To Install Angular CLI npm install -g @angular/cli Run the below command to create the angular application. Command To Create Angular Application ng new name_of_your_app Note: While creating the app, you will see a noti

Unit Testing Asp.NetCore Web API Using xUnit[.NET6]

In this article, we are going to write test cases to an Asp.NetCore Web API(.NET6) application using the xUnit. xUnit For .NET: The xUnit for .Net is a free, open-source, community-focused unit testing tool for .NET applications. By default .Net also provides a xUnit project template to implement test cases. Unit test cases build upon the 'AAA' formula that means 'Arrange', 'Act' and 'Assert' Arrange - Declaring variables, objects, instantiating mocks, etc. Act - Calling or invoking the method that needs to be tested. Assert - The assert ensures that code behaves as expected means yielding expected output. Create An API And Unit Test Projects: Let's create a .Net6 Web API and xUnit sample applications to accomplish our demo. We can use either Visual Studio 2022 or Visual Studio Code(using .NET CLI commands) to create any.Net6 application. For this demo, I'm using the 'Visual Studio Code'(using the .NET CLI command) editor. Create a fo

Part-1 Angular JWT Authentication Using HTTP Only Cookie[Angular V13]

In this article, we are going to implement a sample angular application authentication using HTTP only cookie that contains a JWT token. HTTP Only JWT Cookie: In a SPA(Single Page Application) Authentication JWT token either can be stored in browser 'LocalStorage' or in 'Cookie'. Storing JWT token inside of the cookie then the cookie should be HTTP Only. The HTTP-Only cookie nature is that it will be only accessible by the server application. Client apps like javascript-based apps can't access the HTTP-Only cookie. So if we use authentication with HTTP only JWT cookie then we no need to implement custom logic like adding authorization header or storing token data, etc at our client application. Because once the user authenticated cookie will be automatically sent to the server by the browser on every API call. Authentication API: To implement JWT cookie authentication we need to set up an API. For that, I had created a mock authentication API(Using the NestJS Se

ReactJS(v18) Authentication With JWT AccessToken And Refresh Token

In this article, we are going to do ReactJS(v18) application authentication using the JWT Access Token and Refresh Token. JSON Web Token(JWT): JSON Web Token is a digitally signed and secured token for user validation. The JWT is constructed with 3 important parts: Header Payload Signature Create ReactJS Application: Let's create a ReactJS application to accomplish our demo. npx create-react-app name-of-your-app Configure React Bootstrap Library: Let's install the React Bootstrap library npm install react-bootstrap bootstrap Now add the bootstrap CSS reference in 'index.js'. src/index.js: import 'bootstrap/dist/css/bootstrap.min.css' Create A React Component 'Layout': Let's add a React component like 'Layout' in 'components/shared' folders(new folders). src/components/shared/Layout.js: import Navbar from "react-bootstrap/Navbar"; import { Container } from "react-bootstrap"; import Nav from "react-boot

A Small Guide On NestJS Queues

NestJS Application Queues helps to deal with application scaling and performance challenges. When To Use Queues?: API request that mostly involves in time taking operations like CPU bound operation, doing them synchronously which will result in thread blocking. So to avoid these issues, it is an appropriate way to make the CPU-bound operation separate background job.  In nestjs one of the best solutions for these kinds of tasks is to implement the Queues. For queueing mechanism in the nestjs application most recommended library is '@nestjs/bull'(Bull is nodejs queue library). The 'Bull' depends on Redis cache for data storage like a job. So in this queueing technique, we will create services like 'Producer' and 'Consumer'. The 'Producer' is used to push our jobs into the Redis stores. The consumer will read those jobs(eg: CPU Bound Operations) and process them. So by using this queues technique user requests processed very fastly because actually