Skip to content

RESTowe API oparte o dane GUS dostarczające usługi administracyjno-geolokalizacyjne

License

Notifications You must be signed in to change notification settings

MikSDigital/api-geo

Repository files navigation

GUS API Administracyjno-geolokalizacyjne

RESTowe API dostarczające:

  • struktury administracyjne
    • województwa
    • powiaty
    • gminy
    • miasta, dzielnice i delegatury
    • wsie
    • ulice
  • współrzędne geograficzne struktur administracyjnych budowane przyrostowo dla zadanych requestów

Instalacja

git clone git@github.com:devbay-pl/api-geo.git
cd api-geo
composer install

Następnie na podstaiwe pliku .env.dist utwórz .env z własną konfiguracją.

Migrację schematów bazy danych uruchomisz poleceniem:

bin/console doctrine:schema:update --force

By wlać podstawowe dane administracyjne do bazy danych uruchom:

bin/console app:import

Endpointy

Status Endpoint Metoda Opis Parametry
/api/v1/provinces GET Listing wszystkich województw TODO
/api/v1/provinces/{id} GET Detal województwa o wskazanym id TODO
/api/v1/counties GET Listing wszystkich powiatów TODO
/api/v1/counties/{id} GET Detal powiatu o wskazanym id TODO
/api/v1/communes GET Listing wszystkich gmin TODO
/api/v1/communes/{id} GET Detal gminy o danym id TODO
TODO... TODO... TODO TODO
/_health GET Informacje o stanie usługi TODO

Współtwórcy

Oraz cała społeczność DevBay Community.

Aby znaleźć się na tej liście, wystaw co najmniej 3 pull requesty.

About

RESTowe API oparte o dane GUS dostarczające usługi administracyjno-geolokalizacyjne

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages