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
   6 # under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 3 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # Koha is distributed in the hope that it will be useful, but
  11 # WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  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     # MARC-related types
  50     $self->types->type( marcxml => 'application/marcxml+xml' );
  51     $self->types->type( mij     => 'application/marc-in-json' );
  52     $self->types->type( marc    => 'application/marc' );
  53
  54
  55     my $secret_passphrase = C4::Context->config('api_secret_passphrase');
  56     if ($secret_passphrase) {
  57         $self->secrets([$secret_passphrase]);
  58     }
  59
  60     my $validator = JSON::Validator::OpenAPI::Mojolicious->new;
  61     $validator->load_and_validate_schema(
  62         $self->home->rel_file("api/v1/swagger/swagger.json"),
  63         {
  64           allow_invalid_ref  => 1,
  65         }
  66       );
  67
  68     push @{$self->routes->namespaces}, 'Koha::Plugin';
  69
  70     my $spec = $validator->schema->data;
  71     $self->plugin(
  72         'Koha::REST::Plugin::PluginRoutes' => {
  73             spec      => $spec,
  74             validator => $validator
  75         }
  76     );
  77
  78     $self->plugin(
  79         OpenAPI => {
  80             spec  => $spec,
  81             route => $self->routes->under('/api/v1')->to('Auth#under'),
  82             allow_invalid_ref =>
  83               1,    # required by our spec because $ref directly under
  84                     # Paths-, Parameters-, Definitions- & Info-object
  85                     # is not allowed by the OpenAPI specification.
  86         }
  87     );
  88
  89     $self->plugin( 'Koha::REST::Plugin::Pagination' );
  90     $self->plugin( 'Koha::REST::Plugin::Query' );
  91     $self->plugin( 'Koha::REST::Plugin::Objects' );
  92 }
  93
  94 1;