Koha/REST/V1.pm

   1 package Koha::REST::V1;
   2
   3 # This file is part of Koha.
   4 #
   5 # Koha is free software; you can redistribute it and/or modify it under the
   6 # terms of the GNU General Public License as published by the Free Software
   7 # Foundation; either version 3 of the License, or (at your option) any later
   8 # version.
   9 #
  10 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  11 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  12 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License along
  15 # with Koha; if not, write to the Free Software Foundation, Inc.,
  16 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17
  18 use Modern::Perl;
  19
  20 use Mojo::Base 'Mojolicious';
  21
  22 use C4::Context;
  23
  24 =head1 NAME
  25
  26 Koha::REST::V1 - Main v.1 REST api class
  27
  28 =head1 API
  29
  30 =head2 Class Methods
  31
  32 =head3 startup
  33
  34 Overloaded Mojolicious->startup method. It is called at application startup.
  35
  36 =cut
  37
  38 sub startup {
  39     my $self = shift;
  40
  41     # Remove /api/v1/app.pl/ from the path
  42     $self->hook( before_dispatch => sub {
  43         shift->req->url->base->path('/');
  44     });
  45
  46     # Force charset=utf8 in Content-Type header for JSON responses
  47     $self->types->type(json => 'application/json; charset=utf8');
  48
  49     my $secret_passphrase = C4::Context->config('api_secret_passphrase');
  50     if ($secret_passphrase) {
  51         $self->secrets([$secret_passphrase]);
  52     }
  53
  54     $self->plugin(OpenAPI => {
  55         url => $self->home->rel_file("api/v1/swagger/swagger.json"),
  56         route => $self->routes->under('/api/v1')->to('Auth#under'),
  57         allow_invalid_ref => 1, # required by our spec because $ref directly under
  58                                 # Paths-, Parameters-, Definitions- & Info-object
  59                                 # is not allowed by the OpenAPI specification.
  60     });
  61     $self->plugin( 'Koha::REST::Plugin::Pagination' );
  62     $self->plugin( 'Koha::REST::Plugin::Query' );
  63     $self->plugin( 'Koha::REST::Plugin::Objects' );
  64 }
  65
  66 1;