URI Parser REST API

URI Parser REST API is a simple Mojolicious-based REST API to parse URIs.

Overview

URI Parser REST API uses URI (https://metacpan.org/pod/URI) and Data::Validate::URI (https://metacpan.org/pod/Data::Validate::URI) to parse a given URI and extract its parts.

NOTE: This is just a playground to play with Perl/Mojolicious, nothing serious.

Build

The first step is cloning the URI Parser REST API repository, or downloading its source code.

$ git clone https://github.com/rovellipaolo/mojolicious-uri-parser-rest-api
$ cd mojolicious-uri-parser-rest-api

URI Parser REST API has two ways to be executed: natively in your local environment or in Docker.

Native

To execute URI Parser REST API in your local machine, you need Perl 5.30 or higher installed. Just launch the following commands, which will install all the needed Perl dependencies.

$ make build
$ make run-dev

$ curl -X GET http://127.0.0.1:3000/api/status
{
    "message": "REST API up and running... long live and prosper!"
}

$ curl -H "Content-Type: application/json" -X POST http://127.0.0.1:3000/api/parse -d '{"uri": "https://user:password@domain.tld:8080/path?key=value#fragment"}'
{
    "fragment": "fragment",
    "host": "domain.tld",
    "path": "\/path",
    "port": 8080,
    "query": "key=value",
    "raw": "https:\/\/user:password@domain.tld:8080\/path?key=value#fragment",
    "scheme": "https",
    "userinfo": "user:password"
}

Docker

To execute URI Parser REST API in Docker, you need Docker installed. To build the Docker image, launch the following commands:

$ make build-docker
$ make run-docker

Test

Once you've configured it (see the "Installation" section), you can also run the tests and checkstyle as follows.

$ make test
$ make checkstyle

You can also run the tests with coverage by launching the following command:

$ make test-coverage

Licence

URI Parser REST API is licensed under the GNU General Public License v3.0 (http://www.gnu.org/licenses/gpl-3.0.html).