README.md

GeoService

Info

Geo data REST API service with admin dashboard to manage regions, countries, nationalities, timezones, states, cities and airports.

RoadRunner | PHP8.3 | Symfony 6 | EasyAdminBundle | OpenAPI

Admin Dashboard

Swagger UI

http://127.0.0.1:8085/apidoc

Running

make up

Create a user

make user

Tests

make test

OpenAPI

Regenerate openapi.yaml in project root directory

make openapi

Client installation to your typescript frontend or backend application

npm install @amvid/geo-service

SSL

Roadrunner automatically obtains and refreshes Let's Encrypt certificate.

Import

All geo data

make geo

Currencies

make currencies

Timezones

make timezones

Regions

make regions

Sub regions

make subregions

Countries

make countries

States

make states

Cities

make cities

Airports

make airports
make airports2

Nationalities

make nationalities

API example

Airport

Query

GET /api/v1/airports/London

Response

[
  {
    "title": "London (Any)",
    "iata": "LON",
    "country": "United Kingdom",
    "subregion": "Northern Europe",
    "region": "Europe",
    "children": [
      {
        "title": "London Metropolitan Area",
        "iata": "LON",
        "country": "United Kingdom",
        "region": "Europe",
        "subregion": "Northern Europe"
      },
      {
        "title": "London Heathrow Airport",
        "iata": "LHR",
        "country": "United Kingdom",
        "region": "Europe",
        "subregion": "Northern Europe"
      },
      {
        "title": "London Gatwick Airport",
        "iata": "LGW",
        "country": "United Kingdom",
        "region": "Europe",
        "subregion": "Northern Europe"
      },
      {
        "title": "London City Airport",
        "iata": "LCY",
        "country": "United Kingdom",
        "region": "Europe",
        "subregion": "Northern Europe"
      },
      {
        "title": "London Stansted Airport",
        "iata": "STN",
        "country": "United Kingdom",
        "region": "Europe",
        "subregion": "Northern Europe"
      },
      {
        "title": "London Luton Airport",
        "iata": "LTN",
        "country": "United Kingdom",
        "region": "Europe",
        "subregion": "Northern Europe"
      },
      {
        "title": "London Biggin Hill Airport",
        "iata": "BQH",
        "country": "United Kingdom",
        "region": "Europe",
        "subregion": "Northern Europe"
      },
      {
        "title": "RAF Northolt",
        "iata": "NHT",
        "country": "United Kingdom",
        "region": "Europe",
        "subregion": "Northern Europe"
      }
    ]
  },
  {
    "title": "London Airport",
    "iata": "YXU",
    "country": "Canada",
    "region": "Americas",
    "subregion": "Northern America"
  },
  {
    "title": "London-Corbin Airport/Magee Field",
    "iata": "LOZ",
    "country": "United States",
    "region": "Americas",
    "subregion": "Northern America"
  }
]

License

This software is published under the MIT License