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 use JSON::Validator::OpenAPI::Mojolicious;
  24
  25 =head1 NAME
  26
  27 Koha::REST::V1 - Main v.1 REST api class
  28
  29 =head1 API
  30
  31 =head2 Class Methods
  32
  33 =head3 startup
  34
  35 Overloaded Mojolicious->startup method. It is called at application startup.
  36
  37 =cut
  38
  39 sub startup {
  40     my $self = shift;
  41
  42     # Remove /api/v1/app.pl/ from the path
  43     $self->hook( before_dispatch => sub {
  44         shift->req->url->base->path('/');
  45     });
  46
  47     # Force charset=utf8 in Content-Type header for JSON responses
  48     $self->types->type(json => 'application/json; charset=utf8');
  49
  50     my $secret_passphrase = C4::Context->config('api_secret_passphrase');
  51     if ($secret_passphrase) {
  52         $self->secrets([$secret_passphrase]);
  53     }
  54
  55     my $validator = JSON::Validator::OpenAPI::Mojolicious->new;
  56     $validator->load_and_validate_schema(
  57         $self->home->rel_file("api/v1/swagger/swagger.json"),
  58         {
  59           allow_invalid_ref  => 1,
  60         }
  61       );
  62
  63     push @{$self->routes->namespaces}, 'Koha::Plugin';
  64
  65     my $spec = $validator->schema->data;
  66     $self->plugin(
  67         'Koha::REST::Plugin::PluginRoutes' => {
  68             spec      => $spec,
  69             validator => $validator
  70         }
  71     );
  72
  73     $self->plugin(
  74         OpenAPI => {
  75             spec  => $spec,
  76             route => $self->routes->under('/api/v1')->to('Auth#under'),
  77             allow_invalid_ref =>
  78               1,    # required by our spec because $ref directly under
  79                     # Paths-, Parameters-, Definitions- & Info-object
  80                     # is not allowed by the OpenAPI specification.
  81         }
  82     );
  83
  84     $self->plugin( 'Koha::REST::Plugin::Pagination' );
  85     $self->plugin( 'Koha::REST::Plugin::Query' );
  86     $self->plugin( 'Koha::REST::Plugin::Objects' );
  87 }
  88
  89 1;