Class CategoryController

Namespace: Restaurant.API.Controllers
Assembly: Restaurant.API.dll

Controller made for Restaurant.Domain.Aggregates.CategoryAggregate.Category management.

[ApiController]
[ApiVersion("1.0")]
[Route("api/v{version:apiVersion}/categories")]
public class CategoryController : ControllerBase

Inheritance

object ← ControllerBase ← CategoryController

Inherited Members

Constructors

CategoryController\(IMediator\)

Category controller constructor, injecting IMediator to send requests.

public CategoryController(IMediator mediator)

Parameters

mediator IMediator

Methods

CreateProduct\(Guid, CreateCategoryProductCommand\)

Create a product in a category.

[HttpPut("{categoryGuid}/products")]
[Authorize(Roles = "Admin, Owner")]
[ProducesResponseType(typeof(Category), 200)]
[ProducesResponseType(400)]
[ProducesResponseType(401)]
[ProducesResponseType(403)]
[ProducesResponseType(404)]
[ProducesResponseType(500)]
public Task<ActionResult<Category>> CreateProduct(Guid categoryGuid, CreateCategoryProductCommand command)

Parameters

categoryGuid Guid

Guid of the category.

command CreateCategoryProductCommand

The command to create a product in given category.

Returns

Task < ActionResult <Category\>\>

The updated category.

DeleteCategory\(Guid\)

Delete a category by Guid.

[HttpDelete("{categoryGuid}")]
[Authorize(Roles = "Admin, Owner")]
[ProducesResponseType(204)]
[ProducesResponseType(400)]
[ProducesResponseType(401)]
[ProducesResponseType(403)]
[ProducesResponseType(404)]
[ProducesResponseType(500)]
public Task<ActionResult> DeleteCategory(Guid categoryGuid)

Parameters

categoryGuid Guid

Guid of the category to delete.

Returns

Task < ActionResult \>

A unit value that signify the success of the operation.

GetCategoryById\(Guid\)

Get a category by Guid.

[HttpGet("{categoryGuid}")]
[ProducesResponseType(typeof(Category), 200)]
[ProducesResponseType(400)]
[ProducesResponseType(401)]
[ProducesResponseType(403)]
[ProducesResponseType(404)]
[ProducesResponseType(500)]
public Task<ActionResult<Category>> GetCategoryById(Guid categoryGuid)

Parameters

categoryGuid Guid

Guid of the category to get.

Returns

Task < ActionResult <Category\>\>

The requested category.

InsertFormula\(Guid, CreateCategoryFormulaCommand\)

Create a formula in a category.

[HttpPut("{categoryGuid}/formulas")]
[Authorize(Roles = "Admin, Owner")]
[ProducesResponseType(typeof(Category), 200)]
[ProducesResponseType(400)]
[ProducesResponseType(401)]
[ProducesResponseType(403)]
[ProducesResponseType(404)]
[ProducesResponseType(500)]
public Task<ActionResult<Category>> InsertFormula(Guid categoryGuid, CreateCategoryFormulaCommand command)

Parameters

categoryGuid Guid

Guid of the category.

command CreateCategoryFormulaCommand

The command to create a formula in given category.

Returns

Task < ActionResult <Category\>\>

The updated category.

ReorderCategories\(ReorderCategoriesCommand\)

Update categories by bulk to change their order.

[HttpPut("reorder")]
[Authorize(Roles = "Admin, Owner")]
[ProducesResponseType(typeof(Category), 204)]
[ProducesResponseType(400)]
[ProducesResponseType(401)]
[ProducesResponseType(403)]
[ProducesResponseType(404)]
[ProducesResponseType(500)]
public Task<ActionResult<Unit>> ReorderCategories(ReorderCategoriesCommand command)

Parameters

command ReorderCategoriesCommand

Dictionary that contain Guid and SortingIndex of the Categories.

Returns

Task < ActionResult <Unit\>\>

The updated categories.

UpdateCategory\(Guid, UpdateCategoryCommand\)

Update a category by Guid.

[HttpPut("{categoryGuid}")]
[Authorize(Roles = "Admin, Owner")]
[ProducesResponseType(typeof(Category), 200)]
[ProducesResponseType(400)]
[ProducesResponseType(401)]
[ProducesResponseType(403)]
[ProducesResponseType(404)]
[ProducesResponseType(409)]
[ProducesResponseType(500)]
public Task<ActionResult<Category>> UpdateCategory(Guid categoryGuid, UpdateCategoryCommand command)

Parameters

categoryGuid Guid

Guid of the category to update.

command UpdateCategoryCommand

The command to update a category.

Returns

Task < ActionResult <Category\>\>

The updated category.

Last modified: 21 May 2024