.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Lemonldap::NG::Common::PSGI::Router 3pm"
.TH Lemonldap::NG::Common::PSGI::Router 3pm "2023-05-13" "perl v5.32.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
Lemonldap::NG::Common::PSGI::Router \- Base library for REST APIs of Lemonldap::NG.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  package My::PSGI;
\&  
\&  use base Lemonldap::NG::Common::PSGI::Router;
\&  
\&  sub init {
\&    my ($self,$args) = @_;
\&    # Will be called 1 time during startup
\&    
\&    # Declare REST routes (could be HTML templates or methods)
\&    $self\->addRoute ( \*(Aqindex.html\*(Aq, undef, [\*(AqGET\*(Aq] )
\&         \->addRoute ( books => { \*(Aq:book\*(Aq => \*(AqbooksMethod\*(Aq }, [\*(AqGET\*(Aq, \*(AqPOST\*(Aq] )
\&         \->addRoute ( properties => { \*(Aq*\*(Aq => \*(AqpropertiesMethod\*(Aq }, [\*(AqGET\*(Aq, \*(AqPOST\*(Aq, \*(AqPUT\*(Aq, \*(AqDELETE\*(Aq]);
\&  
\&    # Default route (ie: PATH_INFO == \*(Aq/\*(Aq)
\&    $self\->defaultRoute(\*(Aqindex.html\*(Aq);
\&  
\&    # See Lemonldap::NG::Common::PSGI for other options
\&  
\&    # Return a boolean. If false, then error message has to be stored in
\&    # $self\->error
\&    return 1;
\&  }
\&  
\&  sub booksMethod {
\&    my ( $self, $req, @otherPathInfo ) = @_;
\&    my $book = $req\->params(\*(Aqbook\*(Aq);
\&    my $method = $req\->method;
\&    ...
\&    $self\->sendJSONresponse(...);
\&  }
\&  
\&  sub propertiesMethod {
\&    my ( $self, $property, @otherPathInfo ) = @_;
\&    my $method = $req\->method;
\&    ...
\&    $self\->sendJSONresponse(...);
\&  }
.Ve
.PP
This package could then be called as a \s-1CGI,\s0 using FastCGI,...
.PP
.Vb 1
\&  #!/usr/bin/env perl
\&  
\&  use My::PSGI;
\&  use Plack::Handler::FCGI; # or Plack::Handler::CGI
\&
\&  Plack::Handler::FCGI\->new\->run( My::PSGI\->run() );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This package provides base class for Lemonldap::NG \s-1REST API\s0 but could be
used regardless.
.SH "METHODS"
.IX Header "METHODS"
See Lemonldap::NG::Common::PSGI for logging methods, content sending,...
.SS "Initialization methods"
.IX Subsection "Initialization methods"
\fIaddRoute ( \f(CI$word\fI, \f(CI$dest\fI, \f(CI$methods\fI )\fR
.IX Subsection "addRoute ( $word, $dest, $methods )"
.PP
Declare a \s-1REST\s0 route. Arguments:
.ie n .IP "$word:" 4
.el .IP "\f(CW$word:\fR" 4
.IX Item "$word:"
the first word of /path/info.
.ie n .IP "$dest:" 4
.el .IP "\f(CW$dest:\fR" 4
.IX Item "$dest:"
string, sub ref or hash ref (see \*(L"Route types\*(R" below)
.ie n .IP "$methods:" 4
.el .IP "\f(CW$methods:\fR" 4
.IX Item "$methods:"
array ref containing the methods concerned by this route.
.PP
Route types
.IX Subsection "Route types"
.PP
As seen in \*(L"\s-1SYNOPSIS\*(R",\s0 you can declare routes with variable component. \f(CW$dest\fR
can be:
.IP "a word:" 4
.IX Item "a word:"
the name of the method to call
.IP "undef:" 4
.IX Item "undef:"
\&\f(CW$word\fR is used as \f(CW$dest\fR
.IP "a ref to code:" 4
.IX Item "a ref to code:"
an anonymous subroutin to call
.IP "a hash ref:" 4
.IX Item "a hash ref:"
it's a recursive call to `{ \f(CW$word\fR => \f(CW$dest\fR }`
.IP "an array ref:" 4
.IX Item "an array ref:"
in this case each element of the array will be considered as
`{ \f(CW$element\fR => \f(CW$element\fR }`. So each element must be a word that makes a
correspondence between a path_info word and a subroutine
.PP
Some special \f(CW$word:\fR
.IP "':name':" 4
.IX Item "':name':"
the word in path_info will be stored in \s-1GET\s0 parameters
.IP "'*':" 4
the subroutine will be called with the word of path_info as second argument
(after \f(CW$req\fR)
.IP "'something.html':" 4
.IX Item "'something.html':"
if \f(CW$word\fR finishes with '.html', and \f(CW$dest\fR is undef, then \fBsendHtml()\fR will be
called with 'something.tpl' as template name.
.PP
Examples:
.IP "to manage http://.../books/127 with \fBbook()\fR where 127 is the book number, use:" 4
.IX Item "to manage http://.../books/127 with book() where 127 is the book number, use:"
.Vb 1
\&  $self\->addRoute( books => { \*(Aq:bookId\*(Aq => \*(Aqbook\*(Aq }, [\*(AqGET\*(Aq] );
.Ve
.Sp
bookId parameter will be stored in \f(CW$req\fR\->params('bookId');
.IP "to manage http://.../books/127/pages/5 with \fBpage()\fR, use:" 4
.IX Item "to manage http://.../books/127/pages/5 with page(), use:"
.Vb 1
\&  $self\->addRoute( books => { \*(Aq:bookId\*(Aq => { pages => { \*(Aq:pageId\*(Aq => \*(Aqpage\*(Aq } } }, [\*(AqGET\*(Aq] );
.Ve
.IP "to manage simultaneously the 2 previous examples" 4
.IX Item "to manage simultaneously the 2 previous examples"
.Vb 2
\&  $self\->addRoute( books => { \*(Aq:bookId\*(Aq => { pages => { \*(Aq:pageId\*(Aq => \*(Aqpage\*(Aq } } }, [\*(AqGET\*(Aq] )
\&       \->addRoute( books => { \*(Aq:bookId\*(Aq => { \*(Aq*\*(Aq => \*(Aqbook\*(Aq } }, [\*(AqGET\*(Aq] );
.Ve
.Sp
Note that \fBbook()\fR will be called for any path_info containing /books/<$bookid>/<$other>
except if \f(CW$other\fR == 'pages'.
.IP "to manage /properties/p1, /properties/p2 with \fBp1()\fR and \fBp2()\fR, use:" 4
.IX Item "to manage /properties/p1, /properties/p2 with p1() and p2(), use:"
.Vb 1
\&  $self\->addRoute( properties => [ \*(Aqp1\*(Aq, \*(Aqp2\*(Aq ] );
.Ve
.PP
\fIdefaultRoute($path)\fR
.IX Subsection "defaultRoute($path)"
.PP
This method defined which path_info to use if path_info is '/' or empty.
.SS "Accessors"
.IX Subsection "Accessors"
See Lemonldap::NG::Common::PSGI for inherited accessors (error, languages,
logLevel, staticPrefix, templateDir, links, syslog).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
<http://lemonldap\-ng.org/>, Lemonldap::NG::Portal, Lemonldap::NG::Handler,
Plack, \s-1PSGI\s0, Lemonldap::NG::Common::PSGI,
Lemonldap::NG::Common::PSGI::Request, HTML::Template,
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "LemonLDAP::NG team <http://lemonldap\-ng.org/team>" 4
.IX Item "LemonLDAP::NG team <http://lemonldap-ng.org/team>"
.SH "BUG REPORT"
.IX Header "BUG REPORT"
Use \s-1OW2\s0 system to report bug or ask for features:
<https://gitlab.ow2.org/lemonldap\-ng/lemonldap\-ng/issues>
.SH "DOWNLOAD"
.IX Header "DOWNLOAD"
Lemonldap::NG is available at
<https://lemonldap\-ng.org/download>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
See \s-1COPYING\s0 file for details.
.PP
This library is free software; you can redistribute it and/or modify
it under the terms of the \s-1GNU\s0 General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
.PP
This program is distributed in the hope that it will be useful,
but \s-1WITHOUT ANY WARRANTY\s0; without even the implied warranty of
\&\s-1MERCHANTABILITY\s0 or \s-1FITNESS FOR A PARTICULAR PURPOSE.\s0  See the
\&\s-1GNU\s0 General Public License for more details.
.PP
You should have received a copy of the \s-1GNU\s0 General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.