forked from MDCPS/DamageAssessment_Backend
Swagger Documentation Enhancement (273)
This commit is contained in:
@ -15,7 +15,11 @@ namespace DamageAssesment.Api.Employees.Controllers
|
||||
{
|
||||
this.EmployeeProvider = EmployeesProvider;
|
||||
}
|
||||
//get all Employees
|
||||
|
||||
/// <summary>
|
||||
/// GET request for retrieving employees.
|
||||
/// </summary>
|
||||
|
||||
[HttpGet("Employees")]
|
||||
public async Task<ActionResult> GetEmployeesAsync()
|
||||
{
|
||||
@ -28,7 +32,11 @@ namespace DamageAssesment.Api.Employees.Controllers
|
||||
return NoContent();
|
||||
|
||||
}
|
||||
//get Employee based on Employeeid
|
||||
|
||||
/// <summary>
|
||||
/// GET request for retrieving an employee by ID.
|
||||
/// </summary>
|
||||
|
||||
[HttpGet("Employees/{Id}")]
|
||||
public async Task<ActionResult> GetEmployeeByIdAsync(string Id)
|
||||
{
|
||||
@ -41,8 +49,11 @@ namespace DamageAssesment.Api.Employees.Controllers
|
||||
return NotFound();
|
||||
|
||||
}
|
||||
//update existing Employee
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// PUT request for updating an existing employee.
|
||||
/// </summary>
|
||||
/// <param name="Employee">The updated employee object.</param>
|
||||
[HttpPut("Employees")]
|
||||
public async Task<IActionResult> UpdateEmployee(Db.Employee Employee)
|
||||
{
|
||||
@ -60,7 +71,11 @@ namespace DamageAssesment.Api.Employees.Controllers
|
||||
}
|
||||
return NotFound();
|
||||
}
|
||||
//save new Employee
|
||||
|
||||
/// <summary>
|
||||
/// POST request for creating a new employee.
|
||||
/// </summary>
|
||||
/// <param name="Employee">The employee information for creating a new employee.</param>
|
||||
[HttpPost("Employees")]
|
||||
public async Task<IActionResult> CreateEmployee(Db.Employee Employee)
|
||||
{
|
||||
@ -75,7 +90,10 @@ namespace DamageAssesment.Api.Employees.Controllers
|
||||
}
|
||||
return CreatedAtRoute("DefaultApi", new { id = Employee.Id }, Employee);
|
||||
}
|
||||
//delete existing Employee
|
||||
/// <summary>
|
||||
/// DELETE request for deleting an existing employee.
|
||||
/// </summary>
|
||||
/// <param name="id">The ID of the employee to be deleted.</param>
|
||||
[HttpDelete("Employees/{id}")]
|
||||
public async Task<IActionResult> DeleteEmployee(string id)
|
||||
{
|
||||
|
@ -1,9 +1,10 @@
|
||||
<Project Sdk="Microsoft.NET.Sdk.Web">
|
||||
<Project Sdk="Microsoft.NET.Sdk.Web">
|
||||
|
||||
<PropertyGroup>
|
||||
<TargetFramework>net6.0</TargetFramework>
|
||||
<Nullable>enable</Nullable>
|
||||
<ImplicitUsings>enable</ImplicitUsings>
|
||||
<GenerateDocumentationFile>True</GenerateDocumentationFile>
|
||||
</PropertyGroup>
|
||||
|
||||
<ItemGroup>
|
||||
|
@ -2,6 +2,7 @@ using DamageAssesment.Api.Employees.Db;
|
||||
using DamageAssesment.Api.Employees.Interfaces;
|
||||
using DamageAssesment.Api.Employees.Providers;
|
||||
using Microsoft.EntityFrameworkCore;
|
||||
using System.Reflection;
|
||||
|
||||
var builder = WebApplication.CreateBuilder(args);
|
||||
|
||||
@ -10,7 +11,15 @@ var builder = WebApplication.CreateBuilder(args);
|
||||
builder.Services.AddControllers();
|
||||
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
|
||||
builder.Services.AddEndpointsApiExplorer();
|
||||
builder.Services.AddSwaggerGen();
|
||||
//builder.Services.AddSwaggerGen();
|
||||
builder.Services.AddSwaggerGen(c =>
|
||||
{
|
||||
// Include XML comments from your assembly
|
||||
var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
|
||||
var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
|
||||
c.IncludeXmlComments(xmlPath);
|
||||
});
|
||||
|
||||
builder.Services.AddScoped<IEmployeesProvider, EmployeesProvider>();
|
||||
builder.Services.AddAutoMapper(AppDomain.CurrentDomain.GetAssemblies()); //4/30
|
||||
builder.Services.AddDbContext<EmployeeDbContext>(option =>
|
||||
|
Reference in New Issue
Block a user