thalysonalexr / API-region-br

☁️ Public API with access to cities and states of Brazil 🌇

API-region-br

☁ Public API with access to cities and states of Brazil 🌇

Introduction to API-region-br

API publishes built to serve applications that need information about the regions, states and cities of Brazil. It was built with the Zend Expressive Micro Framework, the relational schema and the data can be accessed in the /database directory.

API Documentation

See the documentation here.

Installation

$ git clone https://github.com/thalysonrodrigues/API-region-br.git

Dependencies

Tested in php >= 7.2.3

This project uses composer to manage your dependencies. Before testing run the following command with the composer already installed on your machine.

$ composer update

Test

This project was tested only on local server using the php embedded server. To run the project, run the following command for the public directory:

$ cd API-region-br
$ php -S localhost:7000 -t public

Credits

• Thalyson Alexandre Rodrigues de Sousa

License

The MIT License (MIT). Please see License File for more information.