This library will help you define a common MVC or Web API interface for your ASP.NET Core applications. It's dependent on the JMayer.Data package and this version will always match the JMayer.Data version.
MVC is used in a server-side only ASP.NET Core project where the project uses the Model-View-Controller pattern. A Model represents the data. A View represents UI for a Model. A Controller represents actions for the View and Model. You can learn more here.
See the JMayer.Data library readme for the Account data object and IAccountDataLayer (database datalayer). The controller utlizes dependency injection to accept an IAccountDataLayer and ILogger interfaces and it interacts with those interfaces when requests are processed.
public AccountController : StandardModelViewController<Account, IAccountDataLayer>
{
public AccountController(IAccountDataLayer dataLayer, ILogger<AccountController> logger) : base(dataLayer, logger) { }
}
You now have a MVC controller for Account actions and your ASP.NET Core application will automatically expose that. It will accept GET & POST calls for /Account. The same can be done when using the StandardSubModelViewController.
Ajax is a pattern where the view contains javascript and javascript will be used to remotely interact with the controller. When the Ajax pattern is used, how the controller responds will need to be altered. In your constructor, you'll need to set a few properties to alter the default.
public AccountController : StandardModelViewController<Account, IAccountDataLayer>
{
public AccountController(IAccountDataLayer dataLayer, ILogger<AccountController> logger) : base(dataLayer, logger)
{
//Json of the object will be returned so javascript can update a table.
IsCUDActionRedirectedOnSuccess = false;
//Json of the ModelState will be returned so javascript can display validation errors on the UI.
ValidationFailedAction = ValidationFailedAction.ReturnJson;
//Not required unless you want to use the details returned as a message to the user.
IsDetailsIncludedInNegativeResponse = true;
}
}
The StandardModelViewController and StandardSubModelViewController can return the following negative responses, 404 (Not Found), 409 (Conflict) and 500 (Internal Server Error). With the MVC pattern, the expectation is to handle those statuses with the middleware using UseStatusCodePagesWithRedirects() or using your own solution. With UseStatusCodePagesWithRedirects(), do not set IsDetailsIncludedInNegativeResponse to true else the redirect won't work. With the Ajax pattern, your javascript will need to handle those statuses when they are returned.
The StandardModelViewController and StandardSubModelViewController will accept a GET /Account/Index web request. The standard is to return a view named "AccountIndex". The view should have UI that displays a list of accounts.
- A ViewResult object is returned by the controller with the account objects; empty list if nothing is found.
- If any exception is thrown, a 500 (Internal Server Error) response will be returned by the controller. The IsDetailsIncludedInNegativeResponse property controls if a detail object is returned or not.
The StandardModelViewController will accept a GET /Account/AddView web request. The standard is to return a view named "AccountAdd". The view should have UI for creating a new account and it should utilize the POST Create action.
- A ViewResult object is returned by the controller. No model is included.
- If any exception is thrown, a 500 (Internal Server Error) response will be returned by the controller. The IsDetailsIncludedInNegativeResponse property controls if a detail object is returned or not.
The StandardModelViewController will accept a GET /Account/AddPartialView web request. The standard is to return a partial view named "_AccountAddPartial". The view should have UI for creating a new account and it should utilize the POST Create action.
- A PartialViewResult object is returned by the controller. No model is included.
- If any exception is thrown, a 500 (Internal Server Error) response will be returned by the controller. The IsDetailsIncludedInNegativeResponse property controls if a detail object is returned or not.
The StandardModelViewController and StandardSubModelViewController will accept a POST /Account/Create web request; the body must contain an Account object. The standard is to call the IAccountDataLayer.CreateAsync() method.
- If the data object creation is successful, a 302 (Redirect) to Index will be returned by the controller or json of the Account object will be returned by the controller. The return action is controlled by the IsCUDActionRedirectedOnSuccess property.
- If the model state is invalid or a DataObjectValidationException is thrown, a ViewResult or PartialViewResult object is returned by the controller or a 400 (Bad Request) response is returned by the controller. The return action is controlled by the ValidationFailedAction property.
- If any other exception is thrown, a 500 (Internal Server Error) response will be returned by the controller. The IsDetailsIncludedInNegativeResponse property controls if a detail object is returned or not.
The StandardModelViewController and StandardSubModelViewController will accept a GET /Account/DeleteView/id web request; id will be DataObject.Integer64ID or DataObject.StringID. The standard is to return a view named "AccountDelete". The view should have UI for deleting an account and it should utilize the POST Delete action.
- When the data object is found using the id, a ViewResult object is returned by the controller with an account object.
- When the data object is not found using the id, a 404 (Not Found) response will be returned by the controller. The IsDetailsIncludedInNegativeResponse property controls if a detail object is returned or not.
- On any exception thrown, a 500 (Internal Server Error) response will be returned by the controller. The IsDetailsIncludedInNegativeResponse property controls if a detail object is returned or not.
The StandardModelViewController and StandardSubModelViewController will accept a GET /Account/DeletePartialView/id web request; id will be DataObject.Integer64ID or DataObject.StringID. The standard is to return a partial view named "_AccountDeletePartial". The view should have UI for deleting an account and it should utilize the POST Delete action.
- When the data object is found, a PartialViewResult object is returned by the controller with an account object.
- When the data object is not found, a 404 (Not Found) response will be returned by the controller.
- On any exception thrown, a 500 (Internal Server Error) response will be returned by the controller. The IsDetailsIncludedInNegativeResponse property controls if a detail object is returned or not.
The StandardModelViewController and StandardSubModelViewController will accept a POST /Account/Delete web request; the body must contain an Account object. The standard is to call the IAccountDataLayer.DeleteAsync() method.
- If the data object deletion is successful, a 302 (Redirect) to Index will be returned by the controller or json of the Account object will be returned by the controller. The return action is controlled by the IsCUDActionRedirectedOnSuccess property.
- If a DataObjectUpdateConflictException is thrown, a 409 (Conflict) response will be returned by the controller. The IsDetailsIncludedInNegativeResponse property controls if a detail object is returned or not.
- If a IDNotFoundException is thrown, a 404 (Not Found) response will be returned by the controller. The IsDetailsIncludedInNegativeResponse property controls if a detail object is returned or not.
- If any other exception is thrown, a 500 (Internal Server Error) response will be returned by the controller. The IsDetailsIncludedInNegativeResponse property controls if a detail object is returned or not.
The StandardModelViewController and StandardSubModelViewController will accept a GET /Account/EditView/id web request; id will be DataObject.Integer64ID or DataObject.StringID. The standard is to return a view named "AccountEdit". The view should have UI for editing an account and it should utilize the POST Update action.
- When the data object is found using the id, a ViewResult object is returned by the controller with an account object.
- When the data object is not found using the id, a 404 (Not Found) response will be returned by the controller. The IsDetailsIncludedInNegativeResponse property controls if a detail object is returned or not.
- On any exception thrown, a 500 (Internal Server Error) response will be returned by the controller. The IsDetailsIncludedInNegativeResponse property controls if a detail object is returned or not.
The StandardModelViewController and StandardSubModelViewController will accept a GET /Account/EditPartialView/id web request; id will be DataObject.Integer64ID or DataObject.StringID. The standard is to return a partial view named "_AccountEditPartial". The view should have UI for editing an account and it should utilize the POST Update action.
- When the data object is found, a PartialViewResult object is returned by the controller with an account object.
- When the data object is not found, a 404 (Not Found) response will be returned by the controller. The IsDetailsIncludedInNegativeResponse property controls if a detail object is returned or not.
- On any exception thrown, a 500 (Internal Server Error) response will be returned by the controller. The IsDetailsIncludedInNegativeResponse property controls if a detail object is returned or not.
The StandardModelViewController and StandardSubModelViewController will accept a POST /Account/Update web request; the body must contain an Account object. The standard is to call the IAccountDataLayer.UpdateAsync() method.
- If the data object update is successful, a 302 (Redirect) to Index will be returned by the controller or json of the Account object will be returned by the controller. The return action is controlled by the IsCUDActionRedirectedOnSuccess property.
- If the model state is invalid or a DataObjectValidationException is thrown, a ViewResult or PartialViewResult object is returned by the controller or a 400 (Bad Request) response is returned by the controller. The return action is controlled by the ValidationFailedAction property.
- If a DataObjectUpdateConflictException is thrown, a 409 (Conflict) response will be returned by the controller. The IsDetailsIncludedInNegativeResponse property controls if a detail object is returned or not.
- If a IDNotFoundException is thrown, a 404 (Not Found) response will be returned by the controller. The IsDetailsIncludedInNegativeResponse property controls if a detail object is returned or not.
- If any other exception is thrown, a 500 (Internal Server Error) response will be returned by the controller. The IsDetailsIncludedInNegativeResponse property controls if a detail object is returned or not.
Let's say you need to check the amount before the account is created. It's easy because the methods are virtual so you can override them.
public AccountController : StandardModelViewController<Account, IAccountDataLayer>
{
public AccountController(IAccountDataLayer dataLayer, ILogger<AccountController> logger) : base(dataLayer, logger) { }
public override async Task<IActionResult> CreateAsync([FromBody] Account dataObject)
{
if (dataObject.TotalAmount < 100)
{
return BadRequest();
}
return await base.CreateAsync(dataObject);
}
}
The same can be done when using the StandardSubModelViewController.
The StandardSubModelViewController is designed to return a subset of data objects for an owner data object so transactions for an account. The IndexAsync() uses the default pattern mapping to accept an owner id and return the subset. The owner id will be stored in the ViewBag and you can use it in the MVC pattern when navigating to an add page. The AddViewAsync() and AddPartialViewAsync() also uses the default pattern mapping to accept an owner id. The owner id will be stored in the ViewBag and when using the MVC pattern, it can be stored in a hidden input in the form so the owner id is added to the data object when posted to the Create action. When using the MVC pattern, the CUD actions, on success, will redirect back to the Index page and the id will be set to the owner id.
Web API is used when there is a client-server split and the client uses the api to remotely request data from the server and to remotely create, delete & update data on the server. You can learn more here.
See the JMayer.Data library readme for the Account data object and IAccountDataLayer (database datalayer). The controller utlizes dependency injection to accept an IAccountDataLayer and ILogger interfaces and it interacts with those interfaces when requests are processed.
[Route("api/[controller]")]
[ApiController]
public AccountController : StandardCRUDController<Account, IAccountDataLayer>
{
public AccountController(IAccountDataLayer dataLayer, ILogger<AccountController> logger) : base(dataLayer, logger) { }
}
You now have a web API controller for Account data and your ASP.NET Core application will automatically expose that. It will accept GET, POST, PUT & DELETE calls for /api/Account. The same can be done when using the UserEditableController and SubUserEditableController.
The StandardCRUDController, UserEditableController and SubUserEditableController will accept a GET api/Account/Count web request. The standard is to call the IAccountDataLayer.CountAsync() method and a web response will be return based on success or failure.
- If querying the count is successful, a 200 (OK) response will be returned by the controller. The count will be returned in the body as an integer.
- If any exception is thrown, a 500 (Internal Server Error) response will be returned by the controller. No body.
The StandardCRUDController, UserEditableController and SubUserEditableController will accept a GET api/Account/All web request. The standard is to call the IAccountDataLayer.GetAllAsync() method and a web response will be return based on success or failure.
- If querying the data objects is successful, a 200 (OK) response will be returned by the controller. A list of Account objects will be returned in the body as json.
- If any exception is thrown, a 500 (Internal Server Error) response will be returned by the controller. No body.
The SubUserEditableController will accept an owner id parameter and it'll return a subset of data objects using the owner id.
The UserEditableController and SubUserEditableController will accept a GET api/Account/All/ListView web request. The standard is to call the IAccountDataLayer.GetAllListViewAsync() method and a web response will be return based on success or failure.
- If querying the data object is successful, a 200 (OK) response will be returned by the controller. A list of ListView objects will be returned in the body as json.
- If any exception is thrown, a 500 (Internal Server Error) response will be returned by the controller. No body.
The SubUserEditableController will accept an owner id parameter and it'll return a subset of data objects using the owner id.
The StandardCRUDController, UserEditableController and SubUserEditableController will accept a GET api/Account/Page web request; the query string will be used to build the QueryDefinition object. The standard is to call the IAccountDataLayer.GetPageAsync() method and a web response will be return based on success or failure.
- If querying the page is successful, a 200 (OK) response will be returned by the controller. A PagedList object with Account objects will be returned in the body as json.
- If any exception is thrown, a 500 (Internal Server Error) response will be returned by the controller. No body.
The SubUserEditableController will accept an owner id parameter and it'll return a subset of data objects using the owner id.
The UserEditableController and SubUserEditableController will accept a GET api/Account/Page/ListView web request; the query string will be used to build the QueryDefinition object. The standard is to call the IAccountDataLayer.GetPageListViewAsync() method and a web response will be return based on success or failure.
- If querying the page is successful, a 200 (OK) response will be returned by the controller. A PagedList object with ListView objects will be returned in the body as json.
- If any exception is thrown, a 500 (Internal Server Error) response will be returned by the controller. No body.
The SubUserEditableController will accept an owner id parameter and it'll return a subset of data objects using the owner id.
The StandardCRUDController, UserEditableController and SubUserEditableController will accept a GET api/Account/Single or GET api/Account/Single/id web request; id will be DataObject.Integer64ID or DataObject.StringID. The standard is to call the IAccountDataLayer.GetSingleAsync() method and a web response will be return based on success or failure.
- If querying the data object is successful, a 200 (OK) response will be returned by the controller. If found, an Account object will be returned in the body as json else nothing is returned.
- If any exception is thrown, a 500 (Internal Server Error) response will be returned by the controller. No body.
The StandardCRUDController, UserEditableController and SubUserEditableController will accept a POST api/Account web request; the body must contain an Account object as json. The standard is to call the IAccountDataLayer.CreateAsync() method and a web response will be return based on success or failure.
- If the data object creation is successful, a 200 (OK) response will be returned by the controller. The Account object will be returned in the body as json.
- If a DataObjectValidationException is thrown, a 400 (Bad Request) response will be returned by the controller. The ServerSideValidationResult object will be returned in the body as json.
- If any other exception is thrown, a 500 (Internal Server Error) response will be returned by the controller. No body.
The StandardCRUDController, UserEditableController and SubUserEditableController will accept a DELETE api/Account/id web request; id will be DataObject.Integer64ID or DataObject.StringID. The standard is to call the IAccountDataLayer.DeleteAsync() method and a web response will be return based on success or failure.
- If the data object deletion is successful, a 200 (OK) response will be returned by the controller. No body.
- If a DataObjectDeleteConflictException is thrown, a 409 (Conflict) response will be returned by the controller. No body.
- If any other exception is thrown, a 500 (Internal Server Error) response will be returned by the controller. No body.
The StandardCRUDController, UserEditableController and SubUserEditableController will accept a PUT api/Account web request; the body must contain an Account object as json. The standard is to call the IAccountDataLayer.UpdateAsync() method and a web response will be return based on success or failure.
- If the data object update is successful, a 200 (OK) response will be returned by the controller. The Account object will be returned in the body as json.
- If a DataObjectValidationException is thrown, a 400 (Bad Request) response will be returned by the controller. The ServerSideValidationResult object will be returned in the body as json.
- If a DataObjectDeleteConflictException is thrown, a 409 (Conflict) response will be returned by the controller. No body.
- If any other exception is thrown, a 500 (Internal Server Error) response will be returned by the controller. No body.
The StandardCRUDController, UserEditableController and SubUserEditableController will accept a POST api/Account/Validate web request; the body must contain an Account object as json. The standard is to call the IAccountDataLayer.ValidateAsync() method and a web response will be return based on success or failure.
- If the data object validation is successful, a 200 (OK) response will be returned by the controller. The ServerSideValidationResult object will be returned in the body as json.
- If any exception is thrown, a 500 (Internal Server Error) response will be returned by the controller. No body.
Let's say you need to check the amount before the account is created. It's easy because the methods are virtual so you can override them.
[Route("api/[controller]")]
[ApiController]
public AccountController : StandardCRUDController<Account, IAccountDataLayer>
{
public AccountController(IAccountDataLayer dataLayer, ILogger<AccountController> logger) : base(dataLayer, logger) { }
public override async Task<IActionResult> CreateAsync([FromBody] Account dataObject)
{
if (dataObject.TotalAmount < 100)
{
return BadRequest();
}
return await base.CreateAsync(dataObject);
}
}
The same can be done when using the UserEditableController and SubUserEditableController.