Build the Assistant API

[LegendarySpork9]

Build the Assistant API and Test it.

[LegendarySpork9]

https://medium.com/@AdanRobles00/how-to-build-a-fully-functional-restful-api-using-c-and-asp-net-core-38fc647b3a16

[LegendarySpork9]

Added authorisation endpoint. Need to complete validation.

[LegendarySpork9]

All endpoints added and tested on the UAT environment.

[LegendarySpork9]

Code rearranged and retested. Submitting to HF for review and suggestions

[LegendarySpork9]

• [x] Change variables to camelCase.
• [x] Remove spaces from variables and classes.
• [x] Change multiple returns to a single return using a results variable.
• [x] If a class only has static variables/methods, make the class static.
• [x] Move dynamic objects to objects.
• [x] Move API responses to models.
• [x] Have a response model just for counts.
• [x] Move all SQL to services that the controller communicates with.

Full details attached. API Feedback.docx

[LegendarySpork9]

Make a validation service to check the models instead of checking in the controller.

[LegendarySpork9]

https://code-maze.com/csharp-get-list-of-properties/#:~:text=Then%2C%20we%20use%20the%20GetType,using%20the%20PrintProperties()%20method. https://stackoverflow.com/questions/3723934/using-propertyinfo-to-find-out-the-property-type

[LegendarySpork9]

https://en.wikipedia.org/wiki/List_of_HTTP_status_codes

[LegendarySpork9]

Need something like the following for validation.

internal class ModelValidationService
{
    public bool IsValid(object model, bool? allRequired = false)
    {
        PropertyInfo[] properties = GetProperties(model);

        foreach (PropertyInfo property in properties)
        {
            Console.WriteLine("{0} is of type {1}", property.Name, property.PropertyType);
            var value = property.GetValue(model, null);

            if (value != null)
            {
                Console.WriteLine("{0} is valid with value {1}", property.Name, value);
            }
        }

        return true;
    }

    private PropertyInfo[] GetProperties(object model)
    {
        return model.GetType().GetProperties();
    }
}

Have the validation service return the response if the model is invalid.

[LegendarySpork9]

Left to do before this can be closed.

• [x] Add login attempts
• [x] Move larger SQL/complex SQL to .sql files
• [x] Check that the correct scopes are applied on each controller
• [x] Remove any redundant namespaces
• [x] Sort namespaces alphabetically
• [x] Clean up comments
• [x] Suppress warnings where needed
• [x] Generic clean up
• [x] Final testing on QA environment

[LegendarySpork9]

Having trouble deploying to the server. Awaiting some help from Kyle to get the application to recognise the URL and use it.

[LegendarySpork9]

Add Endpoint for adding new users.

[LegendarySpork9]

All work complete and tested.