Create & Consume Web API

Create & Consume API

Create & Consume Web API

---

Create Web API for CRUD

Description:

This section outlines the steps required to create a Web API that supports CRUD (Create, Read, Update, Delete) operations. The Web API will be built using a framework such as ASP.NET Core.

Code Example:

csharp
// Startup.cs

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllers();
    // Add other services as required
}

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    // Configure middleware and routing
    app.UseRouting();
    app.UseEndpoints(endpoints =>
    {
        endpoints.MapControllers();
    });
}

Implement Get Method

Description:

This section demonstrates how to implement the GET method in a Web API. The GET method is used to retrieve data from the server.

Code Example:

csharp
// MyController.cs

[HttpGet]
public IActionResult Get()
{
    // Logic to retrieve data from the server
    var data = _repository.GetAll();

    return Ok(data);
}

Implement Post Method

Description:

This section demonstrates how to implement the POST method in a Web API. The POST method is used to send data to the server for creating new resources.

Code Example:

csharp
// MyController.cs

[HttpPost]
public IActionResult Post([FromBody] MyModel model)
{
    // Logic to validate and save the data to the server
    if (!ModelState.IsValid)
    {
        return BadRequest(ModelState);
    }

    _repository.Add(model);

    return CreatedAtAction(nameof(Get), new { id = model.Id }, model);
}

Implement Put Method

Description:

This section demonstrates how to implement the PUT method in a Web API. The PUT method is used to update existing resources on the server.

Code Example:

csharp
// MyController.cs

[HttpPut("{id}")]
public IActionResult Put(int id, [FromBody] MyModel model)
{
    // Logic to validate and update the data on the server
    if (id != model.Id)
    {
        return BadRequest();
    }

    if (!ModelState.IsValid)
    {
        return BadRequest(ModelState);
    }

    _repository.Update(model);

    return NoContent();
}

Implement Delete Method

Description:

This section demonstrates how to implement the DELETE method in a Web API. The DELETE method is used to remove resources from the server.

Code Example:

csharp
// MyController.cs

[HttpDelete("{id}")]
public IActionResult Delete(int id)
{
    // Logic to delete the resource from the server
    var existingModel = _repository.GetById(id);

    if (existingModel == null)
    {
        return NotFound();
    }

    _repository.Delete(existingModel);

    return NoContent();
}

Consume Web API

Description:

This section explains how to consume a Web API from a client application. It covers the steps required to interact with the API endpoints using HTTP methods.

Consume Get Method

Description:

This section explains how to consume the GET method of a Web API. It demonstrates how to send a GET request to retrieve data from the server.

Code Example:

csharp
// HttpClientExample.cs

var httpClient = new HttpClient();
var response = await httpClient.GetAsync("https://example.com/api/mycontroller");

if (response.IsSuccessStatusCode)
{
    var data = await response.Content.ReadAsStringAsync();
    // Process the retrieved data
}

Consume Post Method

Description:

This section explains how to consume the POST method of a Web API. It demonstrates how to send a POST request to create new resources on the server.

Code Example:

csharp
// HttpClientExample.cs

var httpClient = new HttpClient();
var content = new StringContent(JsonConvert.SerializeObject(model), Encoding.UTF8, "application/json");
var response = await httpClient.PostAsync("https://example.com/api/mycontroller", content);

if (response.IsSuccessStatusCode)
{
    // Resource created successfully
}

Consume Put Method

Description:

This section explains how to consume the PUT method of a Web API. It demonstrates how to send a PUT request to update existing resources on the server.

Code Example:

csharp
// HttpClientExample.cs

var httpClient = new HttpClient();
var content = new StringContent(JsonConvert.SerializeObject(model), Encoding.UTF8, "application/json");
var response = await httpClient.PutAsync($"https://example.com/api/mycontroller/{id}", content);

if (response.IsSuccessStatusCode)
{
    // Resource updated successfully
}

Consume Delete Method

Description:

This section explains how to consume the DELETE method of a Web API. It demonstrates how to send a DELETE request to remove resources from the server.

Code Example:

csharp
// HttpClientExample.cs

var httpClient = new HttpClient();
var response = await httpClient.DeleteAsync($"https://example.com/api/mycontroller/{id}");

if (response.IsSuccessStatusCode)
{
    // Resource deleted successfully
}

Consume Web API using HttpClient

Description:

This section explains how to consume a Web API using the HttpClient class in .NET. It demonstrates how to send HTTP requests and handle responses from the API endpoints.

Code Example:

csharp
// HttpClientExample.cs

var httpClient = new HttpClient();
var response = await httpClient.GetAsync("https://example.com/api/mycontroller");

if (response.IsSuccessStatusCode)
{
    var data = await response.Content.ReadAsStringAsync();
    // Process the retrieved data
}

---

Please note that the above examples assume the usage of a fictional "MyController" and "MyModel" for demonstration purposes. You will need to adapt the code examples to fit your specific application and API design.