1 package Koha::REST::V1;
3 # This file is part of Koha.
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.
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.
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>.
20 use Mojo::Base 'Mojolicious';
25 use JSON::Validator::Schema::OpenAPIv2;
27 use Try::Tiny qw( catch try );
31 Koha::REST::V1 - Main v.1 REST api class
39 Overloaded Mojolicious->startup method. It is called at application startup.
46 my $logger = Koha::Logger->get({ interface => 'api' });
50 before_dispatch => sub {
53 # Remove /api/v1/app.pl/ from the path
54 $c->req->url->base->path('/');
57 $c->res->headers->header( 'Access-Control-Allow-Origin' =>
58 C4::Context->preference('AccessControlAllowOrigin') )
59 if C4::Context->preference('AccessControlAllowOrigin');
63 # Force charset=utf8 in Content-Type header for JSON responses
64 $self->types->type( json => 'application/json; charset=utf8' );
66 $self->types->type( marcxml => 'application/marcxml+xml' );
67 $self->types->type( mij => 'application/marc-in-json' );
68 $self->types->type( marc => 'application/marc' );
70 my $secret_passphrase = C4::Context->config('api_secret_passphrase');
71 if ($secret_passphrase) {
72 $self->secrets([$secret_passphrase]);
75 my $spec_file = $self->home->rel_file("api/v1/swagger/swagger.yaml");
77 push @{$self->routes->namespaces}, 'Koha::Plugin';
79 # Try to load and merge all schemas first and validate the result just once.
82 my $schema = JSON::Validator::Schema::OpenAPIv2->new;
84 $schema->resolve( $spec_file );
86 my $spec = $schema->bundle->data;
89 'Koha::REST::Plugin::PluginRoutes' => {
93 ) unless C4::Context->needs_install; # load only if Koha is installed
98 route => $self->routes->under('/api/v1')->to('Auth#under'),
103 # Validation of the complete spec failed. Resort to validation one-by-one
106 # JSON::Validator uses confess, so trim call stack from the message.
107 my $logger = Koha::Logger->get({ interface => 'api' });
108 $logger->error("Warning: Could not load REST API spec bundle: " . $_);
112 my $schema = JSON::Validator::Schema::OpenAPIv2->new;
113 $schema->resolve( $spec_file );
115 my $spec = $schema->bundle->data;
118 'Koha::REST::Plugin::PluginRoutes' => {
122 ) unless C4::Context->needs_install; # load only if Koha is installed
127 route => $self->routes->under('/api/v1')->to('Auth#under'),
132 # JSON::Validator uses confess, so trim call stack from the message.
133 $logger->error("Warning: Could not load REST API spec bundle: " . $_);
137 $self->plugin( 'Koha::REST::Plugin::Pagination' );
138 $self->plugin( 'Koha::REST::Plugin::Query' );
139 $self->plugin( 'Koha::REST::Plugin::Objects' );
140 $self->plugin( 'Koha::REST::Plugin::Exceptions' );