The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
API-McBain-0.1
/ API::McBain::Topic

NAME

API::McBain::Topic - Interface for writing API topics and methods

VERSION

version 0.1

SYNOPSIS

        # in your topic class:
        package MyAPI::Math;

        use API::McBain::Topic          # also imports warnings and strict
                topic => 'math';        # if you don't provide one, McBain will use a lowercased version
                                        # of the end of the package name (in this case, 'math').

        provide('add')
                ->description('Receives two integers, returns their sum.')
                ->param(one => { integer => 1, required => 1 })
                ->param(two => { integer => 1, required => 1 })
                ->returns('integer')
                ->callback(sub {
                        my ($self, %params) = @_;

                        return $params{one} + $params{two};
                });

        provide('subtract')
                ->description('Receives two integers, returns their difference.')
                ->param(one => { integer => 1, required => 1 })
                ->param(two => { integer => 1, required => 1 })
                ->returns('integer')
                ->callback(sub {
                        my ($self, %params) = @_;

                        return $params{one} - $params{two};
                });

        # in application code:
        use MyAPI;

        my $api = MyAPI->new;

        print $api->call('math.add', one => 1, two => 4); # prints 5
        print $api->call('math.add', one => 1); # throws exception "Parameters validation failed"
        print $api->call('math.subtract',
                one => $api->call('math.add', one => 2, two => 3),
                two => 5
        ); # prints 0

DESCRIPTION

This class is the main interface API::McBain provides for writing APIs. For a complete description, see "DESCRIPTION" in API::McBain.

BUGS AND LIMITATIONS

No bugs have been reported.

Please report any bugs or feature requests to bug-API-McBain@rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=API-McBain.

SUPPORT

You can find documentation for this module with the perldoc command.

        perldoc API::McBain::Topic

You can also look for information at:

AUTHOR

Ido Perlmuter <ido@ido50.net>

LICENSE AND COPYRIGHT

Copyright (c) 2013, Ido Perlmuter ido@ido50.net.

This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either version 5.8.1 or any later version. See perlartistic and perlgpl.

The full text of the license can be found in the LICENSE file included with this module.

DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.