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.
47 before_dispatch => sub {
50 # Remove /api/v1/app.pl/ from the path
51 $c->req->url->base->path('/');
54 $c->res->headers->header( 'Access-Control-Allow-Origin' =>
55 C4::Context->preference('AccessControlAllowOrigin') )
56 if C4::Context->preference('AccessControlAllowOrigin');
60 # Force charset=utf8 in Content-Type header for JSON responses
61 $self->types->type( json => 'application/json; charset=utf8' );
63 $self->types->type( marcxml => 'application/marcxml+xml' );
64 $self->types->type( mij => 'application/marc-in-json' );
65 $self->types->type( marc => 'application/marc' );
67 my $secret_passphrase = C4::Context->config('api_secret_passphrase');
68 if ($secret_passphrase) {
69 $self->secrets([$secret_passphrase]);
72 my $spec_file = $self->home->rel_file("api/v1/swagger/swagger.yaml");
74 push @{$self->routes->namespaces}, 'Koha::Plugin';
76 # Try to load and merge all schemas first and validate the result just once.
79 my $schema = JSON::Validator::Schema::OpenAPIv2->new;
81 $schema->resolve( $spec_file );
83 my $spec = $schema->bundle->data;
86 'Koha::REST::Plugin::PluginRoutes' => {
90 ) unless C4::Context->needs_install; # load only if Koha is installed
95 route => $self->routes->under('/api/v1')->to('Auth#under'),
100 # Validation of the complete spec failed. Resort to validation one-by-one
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: " . $_);
109 my $schema = JSON::Validator::Schema::OpenAPIv2->new;
110 $schema->resolve( $spec_file );
112 my $spec = $schema->bundle->data;
115 'Koha::REST::Plugin::PluginRoutes' => {
119 ) unless C4::Context->needs_install; # load only if Koha is installed
124 route => $self->routes->under('/api/v1')->to('Auth#under'),
129 # JSON::Validator uses confess, so trim call stack from the message.
130 $logger->error("Warning: Could not load REST API spec bundle: " . $_);
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' );