The RESTful API for costs to expect, the website will consume the data, the iOS app and Web App are initially for entering data
Clone or download
Permalink
Failed to load latest commit information.
.docker Config Sep 10, 2018
app Refactoring, conditional POST parameters Sep 23, 2018
bootstrap Laravel Jul 17, 2018
config Release version Sep 23, 2018
database Log API requests Aug 20, 2018
public HTTP 405 "Method Not Allowed" Sep 19, 2018
resources Passport Jul 18, 2018
routes Month(s) summaries Sep 21, 2018
storage Laravel Jul 17, 2018
tests Laravel Jul 17, 2018
.env.example Config changes Aug 22, 2018
.gitattributes Laravel Jul 17, 2018
.gitignore Fixes and ide helper Jul 24, 2018
CHANGELOG.md Release version Sep 23, 2018
LICENSE Initial commit Apr 11, 2018
README.md Refactoring, conditional POST parameters Sep 23, 2018
artisan Laravel Jul 17, 2018
composer.json v1.01.0 release Sep 10, 2018
composer.lock v1.01.0 release Sep 10, 2018
docker-compose.yml Docker Jul 17, 2018
package.json Laravel Jul 17, 2018
phpunit.xml Laravel Jul 17, 2018
server.php Laravel Jul 17, 2018
webpack.mix.js Laravel Jul 17, 2018

README.md

Costs to expect

Overview

What does it costs to raise a child in the UK?

Costs to Expect is a long-term project, my wife and I are tracking the expenses to raise our child to adulthood, 18.

Why?

There are two core reasons as to why I/we are doing this. I love data, and over the last twenty years, it appears to have become accepted knowledge that it costs £250k to raise a child in the UK.

If you think about the number, it becomes apparent quickly that it can't be right, on average over £10k a year?

This API will show the costs to raise my child; obviously, every family is different, these costs only relate to my family, more details will appear on https://www.costs-to-expect.com as the site develops.

The API

This Laravel app is the RESTful API for https://api.costs-to-expect.com, the API will be consumed by the costs to expect website and iOS app which I'm creating to assist the wife with data input.

Set up

I'm going to assume you are using Docker, if not you should be able to work out what you need to run for your development setup, go to the project root directory and run the below.

Environment

  • Run docker-compose build
  • Create the following directories in .docker, .docker/app/php, .docker/app/mysql and .docker/app/mysql/data
  • Run docker-compose up

App

We now have a working environment, lets set up the app. There are two Docker services, app and mysql, we need to exec into the app service to set up our app.

First, let us check we are trying to access the right place, run docker-compose exec app ls. You should see a list of the files and directories at the root of our project, if you can see artisan, you are in the right place, otherwise see where you are and adjust accordingly.

Now we need to set up the app by setting our .env, installing our dependencies and then running any migrations and install Passport.

  • Copy the .env.example file and name the copy .env, set your environment settings
  • composer install
  • docker-compose exec app php artisan migrate
  • docker-compose exec app php artisan passport:install
  • Run a OPTIONS request on http://api.local/v1/resource_types, you should see a nice OPTIONS request, alternatively a GET request to http://api.local/v1 will show all the routes.
  • You can add a development user by POSTing to http://api.local/v1/auth/register and then get a bearer by POSTing to http://api.local/v1/auth/login - you will need a bearer for all the routes that require authentication.

Responses

  • Collections will return an array and 200.
  • Items will return a single object and a 200.
  • Successful POST requests will return a single object and a 201.
  • Successful DELETE requests will return a 204.
  • Non 2xx results will return an object with a message field and optionally a fields field, for example containing the validation errors.

Routes

Please find below a list of the API routes that are (will be) implemented for version 1.00.

HTTP Verb(s) Route
GET/HEAD v1/
OPTIONS v1/
POST v1/auth/login
POST v1/auth/register (Removed in production)
OPTIONS v1/categories
GET/HEAD v1/categories
OPTIONS v1/categories/{category_id}
GET/HEAD v1/categories/{category_id}
OPTIONS v1/categories/{category_id}/sub_categories
GET/HEAD v1/categories/{category_id}/sub_categories
OPTIONS v1/categories/{category_id}/sub_categories/{sub_category_id}
GET/HEAD v1/categories/{category_id}/sub_categories/{sub_category_id}
GET/HEAD v1/resource_types
OPTIONS v1/resource_types
GET/HEAD v1/resource_types/{resource_type_id}
OPTIONS v1/resource_types/{resource_type_id}
GET/HEAD v1/resource_types/{resource_type_id}/resources
OPTIONS v1/resource_types/{resource_type_id}/resources
OPTIONS v1/resource_types/{resource_type_id}/resources/{resource_id}
GET/HEAD v1/resource_types/{resource_type_id}/resources/{resource_id}
OPTIONS v1/resource_types/{resource_type_id}/resources/{resource_id}/items
GET/HEAD v1/resource_types/{resource_type_id}/resources/{resource_id}/items
GET/HEAD v1/resource_types/{resource_type_id}/resources/{resource_id}/items/{item_id}
OPTIONS v1/resource_types/{resource_type_id}/resources/{resource_id}/items/{item_id}
OPTIONS v1/resource_types/{resource_type_id}/resources/{resource_id}/items/{item_id}/category
GET/HEAD v1/resource_types/{resource_type_id}/resources/{resource_id}/items/{item_id}/category
GET/HEAD v1/resource_types/{resource_type_id}/resources/{resource_id}/items/{item_id}/category/{item_category_id}
OPTIONS v1/resource_types/{resource_type_id}/resources/{resource_id}/items/{item_id}/category/{item_category_id}
OPTIONS v1/resource_types/{resource_type_id}/resources/{resource_id}/items/{item_id}/category/{item_category_id}/sub_category
GET/HEAD v1/resource_types/{resource_type_id}/resources/{resource_id}/items/{item_id}/category/{item_category_id}/sub_category
GET/HEAD v1/resource_types/{resource_type_id}/resources/{resource_id}/items/{item_id}/category/{item_category_id}/sub_category/{sub_category_id}
OPTIONS v1/resource_types/{resource_type_id}/resources/{resource_id}/items/{item_id}/category/{item_category_id}/sub_category/{sub_category_id}

Summary routes

HTTP Verb(s) Route
GET/HEAD v1/resource_types/{resource_type_id}/resources/{resource_id}/summary/tco
OPTIONS v1/resource_types/{resource_type_id}/resources/{resource_id}/summary/tco
GET/HEAD v1/resource_types/{resource_type_id}/resources/{resource_id}/summary/categories
OPTIONS v1/resource_types/{resource_type_id}/resources/{resource_id}/summary/categories
GET/HEAD v1/resource_types/{resource_type_id}/resources/{resource_id}/summary/categories/{category_id}
OPTIONS v1/resource_types/{resource_type_id}/resources/{resource_id}/summary/categories/{category_id}
GET/HEAD v1/resource_types/{resource_type_id}/resources/{resource_id}/summary/categories/{category_id}/sub_categories
OPTIONS v1/resource_types/{resource_type_id}/resources/{resource_id}/summary/categories/{category_id}/sub_categories
GET/HEAD v1/resource_types/{resource_type_id}/resources/{resource_id}/summary/categories/{category_id}/sub_categories/{sub_category_id}
OPTIONS v1/resource_types/{resource_type_id}/resources/{resource_id}/summary/categories/{category_id}/sub_categories/{sub_category_id}
GET/HEAD v1/resource_types/{resource_type_id}/resources/{resource_id}/summary/years
OPTIONS v1/resource_types/{resource_type_id}/resources/{resource_id}/summary/years
GET/HEAD v1/resource_types/{resource_type_id}/resources/{resource_id}/summary/years/{year}
OPTIONS v1/resource_types/{resource_type_id}/resources/{resource_id}/summary/years/{year}
GET/HEAD v1/resource_types/{resource_type_id}/resources/{resource_id}/summary/years/{year}/months
OPTIONS v1/resource_types/{resource_type_id}/resources/{resource_id}/summary/years/{year}/months
GET/HEAD v1/resource_types/{resource_type_id}/resources/{resource_id}/summary/years/{year}/months/{month}
OPTIONS v1/resource_types/{resource_type_id}/resources/{resource_id}/summary/years/{year}/months/{month}

Management routes

Please find below a list of the API management routes, these routes require authorisation.

HTTP Verb(s) Route
GET v1/auth/user
POST v1/categories
DELETE v1/categories/{category_id}
POST v1/categories/{category_id}/sub_categories
DELETE v1/categories/{category_id}/sub_categories/{sub_category_id}
POST v1/resource_types
DELETE v1/resource_types/{resource_type_id}
POST v1/resource_types/{resource_type_id}/resources
DELETE v1/resource_types/{resource_type_id}/resources/{resource_id}
POST v1/resource_types/{resource_type_id}/resources/{resource_id}/items
DELETE v1/resource_types/{resource_type_id}/resources/{resource_id}/items/{item_id}
POST v1/resource_types/{resource_type_id}/resources/{resource_id}/items/{item_id}/category
DELETE v1/resource_types/{resource_type_id}/resources/{resource_id}/items/{item_id}/category/{item_category_id}
POST v1/resource_types/{resource_type_id}/resources/{resource_id}/items/{item_id}/category/{item_category_id}/sub_category
DELETE v1/resource_types/{resource_type_id}/resources/{resource_id}/items/{item_id}/category/{item_category_id}/sub_category/{sub_category_id}

Planned development

  • Added filtering options for all GET routes, initially items route.
  • Validate GET parameters.
  • PATCH support.
  • PUTS support.
  • Upgrade Laravel to 5.7.
  • Move the user model.
  • Dev setting to show generated queries.
  • Switch to Money class.
  • Create a white box version of API.
  • Refactoring.
  • Add limits on POST for single item collections.