stefano/address

Slovak Post Address API

0.0.6 2019-12-01 21:29 UTC

Requires

• php: ^7.1.3
• ext-ctype: *
• ext-iconv: *
• ext-zip: *
• doctrine/doctrine-bundle: ^2.0
• phpoffice/phpspreadsheet: ^1.8
• symfony/console: ^5.0
• symfony/dotenv: ^5.0
• symfony/flex: ^1.4
• symfony/framework-bundle: ^5.0
• symfony/twig-bundle: ^5.0
• symfony/yaml: ^5.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.12
• phpunit/phpunit: ^8.2
• symfony/debug-pack: ^1.0

Conflicts

• symfony/symfony: *

Replaces

• symfony/polyfill-ctype: *
• symfony/polyfill-iconv: *
• symfony/polyfill-php56: *
• symfony/polyfill-php70: *
• symfony/polyfill-php71: *

BSD-3-Clause

• Štefan Bartko

• symfony
• api
• address
• autocomplete
• slovak

README

Online DEMO

Installation

• run composer create-project stefano/address my-project
• create database database.sql
• rename .end.dist to .env and fill it with your settings
• run import bin/console import:address

API Endpoints Documentation

GET /api/address

• fields [array] [optional]
  • [string] street, city, postcode, post_office
• filters [array] [optional]
  • street [string] [optional]
  • city [string] [optional]
  • postcode [string] [optional]
  • post_office [string] [optional]
• orders [array] [optional]
  • [string] street, city, postcode, post_office
• order-direction [asc or desc] [optional] default asc
• limit [number] [optional] default 20
• offset [number] [optional] default 0

Response:

{
    items: [
        street, string,
        city: string,
        postcode: string,
        post_office: string
    ]
}