Repository files navigation

Simple example of API that allows to store some interesting places with their map coordinates and description.

With this API you can:

• Add Point info (name, description, coordinates, city)
• Edit Point info
• Get nearest Points by desired radius and IP address
• Get Points located in desired city

1. In project folder executedocker-compose up -d
2. Enter container withdocker exec -ti points bash
3. Executecomposer install
4. Rename.env.example file into.env
5. Execute./artisan migrate --force to run database migrations
6. In.env file write yourIP_STACK_KEY andAPI_TOKEN
7. Check api status by addresshttp://localhost:8080/api/v1/health?api_token=123

To run unit tests executevendor/bin/phpunit tests/unit insidepoints container.

To run only functional tests executevendor/bin/phpunit tests/functional.

To run all tests executevendor/bin/phpunit.

All requests must containapi_token parameter withAPI_TOKEN environment variable value.

Example:GET /api/v1/health?api_token=123

Get health status of the service.

URL:GET /api/v1/health

Description

Endpoints for viewing and manipulating points.

• Add Point:POST /api/v1/points
• Update Point:PUT /api/v1/points/:pk
• Show points by desired ip and radius:GET /api/v1/points/inrad
• Show points in desired city:GET /api/v1/points/in/:city