Note Onion - 4 - API - NoteTypeController

Here is the source code for NoteTypeController.cs This is placed in the Controllers folder of the Note.Api class

using System.Threading.Tasks;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Mvc;
using Note.Application.DTOs;
using Note.Application.Services;
using Note.Shared;
using Notes.API;
using Swashbuckle.AspNetCore.Annotations;
using Swashbuckle.AspNetCore.Filters;

namespace Notes.API.Controllers
{
    [ApiController]
    [Route("api/[controller]")]
    public class NoteTypeController : ControllerBase
    {
        private readonly INoteTypeService _noteTypeService;

        public NoteTypeController(INoteTypeService noteTypeService)
        {
            _noteTypeService = noteTypeService;
        }

        /// <summary>
        /// Returns a list of all note types
        /// </summary>
        /// <returns>
        /// A result(NoteTypeVM) object containing a collection of
        /// note type objects.
        /// </returns>
        /// <param name="companyKey">Code given to you to help identify your company</param>
        /// <param name="applicationKey">A filter representing an application integrated into this microservice</param>
        /// <remarks>Get: api/noteTypes</remarks>
        [HttpGet("{companyKey}/{applicationKey}")]
        [SwaggerResponse(
            StatusCodes.Status200OK,
            "HTTP 200 means a model is being returned. Check the WasSuccessfulTrue to determine if it worked properly", 
            typeof(IResult<List<NoteTypeDto>>))]
        [SwaggerResponseExample(
            StatusCodes.Status200OK,
            typeof(NoteTypeControllerSwashbuckleExamples.NoteTypeGetAllExample))]
        public async Task<IActionResult> GetNoteTypesAsync(
            string companyKey, 
            string applicationKey)
        {
            var result = await _noteTypeService.GetNoteTypes(companyKey, applicationKey);
            return Ok(result);
        }

        /// <summary>
        /// Returns one NoteType object based on an ID provided
        /// </summary>
        /// <param name="companyKey">This is a code given to your agency</param>
        /// <param name="id">
        /// This is the ID of the notetype object you are looking for
        /// </param>
        /// <returns></returns>
        // Get: api/noteType/x
        [HttpGet("{companyKey}/app{id}")]
        [SwaggerResponse(
            StatusCodes.Status200OK, 
            type: typeof(BaseResult<NoteTypeDto>))]
        [SwaggerResponseExample(
            StatusCodes.Status200OK, 
            typeof(NoteTypeControllerSwashbuckleExamples.NoteTypeGetOneExample))]
        public async Task<IActionResult> GetNoteTypeById(
            string companyKey, 
            long id)
        {
            var result = await _noteTypeService.GetNoteTypeById(companyKey, id);
            return Ok(result);
        }

        ///// <summary>
        ///// Returns a result(NoteTypeVM) object. A new object
        ///// </summary>
        ///// <returns></returns>
        //[HttpGet("null")]
        ////[SwaggerResponse(StatusCodes.Status200OK, null, typeof(IResult<NoteTypeViewModel>))]
        ////[SwaggerResponseExample(StatusCodes.Status200OK, typeof(NoteTypeControllerSwashbuckleExamples.NoteTypeGetOneExampleNull))]
        //public Task<IActionResult> GetOne()
        //{
        //    return ReturnResult(new Result<List<NoteTypeDto>>());
        //    //var result = await _noteTypeService.GetNoteById(companyKey, id);
        //    //return Ok(result);
        //}


        /// <summary>
        /// Adds a NoteTypeVM object to the database
        /// </summary>
        /// <param name="noteTypeVm"></param>
        /// <returns></returns>
        [HttpPost]
        [SwaggerRequestExample(typeof(NoteTypeDto), typeof(NoteTypeControllerSwashbuckleExamples.NoteTypePostExample))]
        [SwaggerResponse(
            StatusCodes.Status200OK,
            "HTTP 200 means a model is being returned. Check the WasSuccessfulTrue to determine if it worked properly", 
            typeof(IResult<NoteTypeDto>))]
        [SwaggerResponseExample(
            StatusCodes.Status200OK, 
            typeof(NoteTypeControllerSwashbuckleExamples.NoteTypePostResultsExampleSuccess))]
        public async Task<IActionResult> CreateNoteType(
            [FromBody] NoteTypeDto noteTypeDto)
        {
            var result = await _noteTypeService.CreateNoteType(noteTypeDto);
            return Ok(result);
        }

        //[SwaggerResponse(StatusCodes.Status200OK, type: typeof(BaseResult<bool>))]
        /// <summary>
        /// Update the database with the NoteTypeVM object being provided.
        /// </summary>
        /// <param name="id">ID of the notetype code being updated</param>
        /// <returns></returns>
        [HttpPut("{id}")]
        [SwaggerRequestExample(
            typeof(NoteTypeDto), 
            typeof(NoteTypeControllerSwashbuckleExamples.NoteTypePutExample))]
        [SwaggerResponseExample(
            StatusCodes.Status200OK, 
            typeof(NoteTypeControllerSwashbuckleExamples.NoteTypePostResultsExampleSuccess))]
        public async Task<IActionResult> UpdateNoteType(
            long id, 
            [FromBody] NoteTypeDto noteTypeDto)
        {
            noteTypeDto.Id = id;
            var result = await _noteTypeService.UpdateNoteType(noteTypeDto);
            return Ok(result);
        }

        //[HttpDelete("{id}")]
        //[SwaggerResponse(StatusCodes.Status200OK, type: typeof(BaseResult<bool>))]
        /// <summary>
        /// Delete's a NoteType object from the database.
        /// </summary>
        /// <param name="companyKey">This is a code given to your agency</param>
        /// <param name="id">
        /// This is the ID of the note that should be deleted
        /// </param>
        /// <returns></returns>
        [HttpDelete("{companyKey}/{id}")]
        [SwaggerResponse(
            StatusCodes.Status200OK,
            "HTTP 200 means a model is being returned. Check the WasSuccessfulTrue to determine if it worked properly", 
            typeof(IResult<NoteTypeDto>))]
        [SwaggerResponseExample(
            StatusCodes.Status200OK, 
            typeof(NoteTypeControllerSwashbuckleExamples.NoteTypeDeleteResultsExampleSuccess))]
        public async Task<IActionResult> DeleteNoteType(
            string companyKey, 
            long id)
        {
            var result = await _noteTypeService.DeleteNoteType(companyKey, id);
            return Ok(result);
        }
    }
}