pinkhamsoftware/asset-register-api

Homes England Asset Register API

Asset Register API

The role of the Asset Register API is to create, update and serve asset data for the Asset Register Frontend.

Current endpoints

Documentation

When serving the application, current API docs live at localhost:5000/swagger

Testing the application

Once you have cloned the repository run all tests with the following command:

make test

Running the application

Creating dummy data

To fill the database with 100 rows of autogenerated data, you can use the command:

make seeds

Serving

Once you have cloned the repository you can run the application with the following command:

make serve

The application runs on port 5000.

Third party services used by this project

• Gov PaaS
• Sentry
• Circle CI

WebAPI

CSV Generation

WebApiContrib.Core.Formatter.Csv library has been used to automatically generate CSV data from an IEnumerable<T> once the accept: text/csv header is sent in the request. Please refer to Csv Outputter. Please refer to architectural decision record 1.