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