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     $self->hook(
  43         before_dispatch => sub {
  44             my $c = shift;
  45
  46             # Remove /api/v1/app.pl/ from the path
  47             $c->req->url->base->path('/');
  48
  49             # Handle CORS
  50             $c->res->headers->header( 'Access-Control-Allow-Origin' =>
  51                   C4::Context->preference('AccessControlAllowOrigin') )
  52               if C4::Context->preference('AccessControlAllowOrigin');
  53         }
  54     );
  55
  56     # Force charset=utf8 in Content-Type header for JSON responses
  57     $self->types->type( json    => 'application/json; charset=utf8' );
  58     # MARC-related types
  59     $self->types->type( marcxml => 'application/marcxml+xml' );
  60     $self->types->type( mij     => 'application/marc-in-json' );
  61     $self->types->type( marc    => 'application/marc' );
  62
  63
  64     my $secret_passphrase = C4::Context->config('api_secret_passphrase');
  65     if ($secret_passphrase) {
  66         $self->secrets([$secret_passphrase]);
  67     }
  68
  69     my $validator = JSON::Validator::OpenAPI::Mojolicious->new;
  70     $validator->load_and_validate_schema(
  71         $self->home->rel_file("api/v1/swagger/swagger.json"),
  72         {
  73           allow_invalid_ref  => 1,
  74         }
  75       );
  76
  77     push @{$self->routes->namespaces}, 'Koha::Plugin';
  78
  79     my $spec = $validator->schema->data;
  80     $self->plugin(
  81         'Koha::REST::Plugin::PluginRoutes' => {
  82             spec      => $spec,
  83             validator => $validator
  84         }
  85     );
  86
  87     $self->plugin(
  88         OpenAPI => {
  89             spec  => $spec,
  90             route => $self->routes->under('/api/v1')->to('Auth#under'),
  91             allow_invalid_ref =>
  92               1,    # required by our spec because $ref directly under
  93                     # Paths-, Parameters-, Definitions- & Info-object
  94                     # is not allowed by the OpenAPI specification.
  95         }
  96     );
  97
  98     $self->plugin( 'Koha::REST::Plugin::Pagination' );
  99     $self->plugin( 'Koha::REST::Plugin::Query' );
 100     $self->plugin( 'Koha::REST::Plugin::Objects' );
 101 }
 102
 103 1;