WebService::Swapi - Perl library for accessing the Star Wars data, http://swapi.co
use WebService::Swapi;
$swapi = WebService::Swapi->new;
# Check if API server is up
my $resources = $swapi->ping();
# Get information of all available resources
my $resources = $swapi->resources();
# View the JSON schema for people resource
my $schema = $swapi->schema('people');
# Searching
my $results = $swapi->search('people', 'solo');
# Get resource item
my $item = $swapi->get_object('films', '1');
WebService::Swapi is a Perl client helper library for the Star Wars API (swapi.co).
Source repository at https://github.com/kianmeng/webservice-swapi.
If you have Docker installed, you can build your Docker container for this project.
$ docker build -t webservice-swapi .
$ docker run -it -v $(pwd):/root webservice-swapi bash
# cpanm --installdeps --notest .
Setting up the required packages.
$ milla authordeps --missing | cpanm
$ milla listdeps --missing | cpanm
Check you code coverage.
$ milla cover
Several ways to run the test.
$ milla test
$ milla test --author --release
$ AUTHOR_TESTING=1 RELEASE_TESTING=1 milla test
$ AUTHOR_TESTING=1 RELEASE_TESTING=1 milla run prove t/01_instantiation.t
Release the module.
$ milla build
$ milla release
Construct a new WebService::Swapi instance. Optionally takes a hash or hash reference.
# Instantiate the class.
my $swapi = WebService::Swapi->new;
The URL of the API resource.
# Instantiate the class by setting the URL of the API endpoints.
my $swapi = WebService::Swapi->new({api_url => 'http://example.com/api/'});
Get full details of a object or resource. Optionally takes a returned format.
# Get the details of different available object using id.
my $object = $swapi->get_object('films', '1');
# Get the result in different format.
my $object_json = $swapi->get_object('films', '1', 'json');
my $object_wookie = $swapi->get_object('films', '1', 'wookiee');
Check if the API service or server is responding to a request.
my $server_status = $swapi->ping();
List down all the available objects. Optionally takes a returned format.
# Get all available resources or objects.
my $resources = $swapi->resources();
# Similarly but in different format.
my $resources_json = $swapi->resources('json');
my $resources_wookie = $swapi->resources('wookie');
Show the data structure of a resource or object.
# Get the schema / structure of a resource or object.
my $schema = $swapi->schema('people');
Searching by keywords. Takes both an object and keywords. Optionally takes a returned format.
# Search a resource or object by keywords.
my $results = $swapi->search('people', 'solo');
# Or in different format.
my $results = $swapi->search('people', 'solo', 'json');
my $results = $swapi->search('people', 'solo', 'wookiee');
Kian-Meng, Ang kianmeng@cpan.org
This software is Copyright (c) 2017 by Kian Meng, Ang.
This is free software, licensed under:
The Artistic License 2.0 (GPL Compatible)