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 Koha::Logger;
  24
  25 use JSON::Validator::Schema::OpenAPIv2;
  26
  27 use Try::Tiny qw( catch try );
  28
  29 =head1 NAME
  30
  31 Koha::REST::V1 - Main v.1 REST api class
  32
  33 =head1 API
  34
  35 =head2 Class Methods
  36
  37 =head3 startup
  38
  39 Overloaded Mojolicious->startup method. It is called at application startup.
  40
  41 =cut
  42
  43 sub startup {
  44     my $self = shift;
  45
  46     $self->hook(
  47         before_dispatch => sub {
  48             my $c = shift;
  49
  50             # Remove /api/v1/app.pl/ from the path
  51             $c->req->url->base->path('/');
  52
  53             # Handle CORS
  54             $c->res->headers->header( 'Access-Control-Allow-Origin' =>
  55                   C4::Context->preference('AccessControlAllowOrigin') )
  56               if C4::Context->preference('AccessControlAllowOrigin');
  57         }
  58     );
  59
  60     # Force charset=utf8 in Content-Type header for JSON responses
  61     $self->types->type( json    => 'application/json; charset=utf8' );
  62     # MARC-related types
  63     $self->types->type( marcxml => 'application/marcxml+xml' );
  64     $self->types->type( mij     => 'application/marc-in-json' );
  65     $self->types->type( marc    => 'application/marc' );
  66
  67     my $secret_passphrase = C4::Context->config('api_secret_passphrase');
  68     if ($secret_passphrase) {
  69         $self->secrets([$secret_passphrase]);
  70     }
  71
  72     my $spec_file = $self->home->rel_file("api/v1/swagger/swagger.yaml");
  73
  74     push @{$self->routes->namespaces}, 'Koha::Plugin';
  75
  76     # Try to load and merge all schemas first and validate the result just once.
  77     try {
  78
  79         my $schema = JSON::Validator::Schema::OpenAPIv2->new;
  80
  81         $schema->resolve( $spec_file );
  82
  83         my $spec = $schema->bundle->data;
  84
  85         $self->plugin(
  86             'Koha::REST::Plugin::PluginRoutes' => {
  87                 spec     => $spec,
  88                 validate => 0,
  89             }
  90         ) unless C4::Context->needs_install; # load only if Koha is installed
  91
  92         $self->plugin(
  93             OpenAPI => {
  94                 spec  => $spec,
  95                 route => $self->routes->under('/api/v1')->to('Auth#under'),
  96             }
  97         );
  98     }
  99     catch {
 100         # Validation of the complete spec failed. Resort to validation one-by-one
 101         # to catch bad ones.
 102
 103         # JSON::Validator uses confess, so trim call stack from the message.
 104         my $logger = Koha::Logger->get({ interface => 'api' });
 105         $logger->error("Warning: Could not load REST API spec bundle: " . $_);
 106
 107         try {
 108
 109             my $schema = JSON::Validator::Schema::OpenAPIv2->new;
 110             $schema->resolve( $spec_file );
 111
 112             my $spec = $schema->bundle->data;
 113
 114             $self->plugin(
 115                 'Koha::REST::Plugin::PluginRoutes' => {
 116                     spec     => $spec,
 117                     validate => 1
 118                 }
 119             )  unless C4::Context->needs_install; # load only if Koha is installed
 120
 121             $self->plugin(
 122                 OpenAPI => {
 123                     spec  => $spec,
 124                     route => $self->routes->under('/api/v1')->to('Auth#under'),
 125                 }
 126             );
 127         }
 128         catch {
 129             # JSON::Validator uses confess, so trim call stack from the message.
 130             $logger->error("Warning: Could not load REST API spec bundle: " . $_);
 131         };
 132     };
 133
 134     $self->plugin( 'Koha::REST::Plugin::Pagination' );
 135     $self->plugin( 'Koha::REST::Plugin::Query' );
 136     $self->plugin( 'Koha::REST::Plugin::Objects' );
 137     $self->plugin( 'Koha::REST::Plugin::Exceptions' );
 138 }
 139
 140 1;