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 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
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.
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.
18 use Mojo::Base 'Mojolicious';
21 use JSON::Validator::OpenAPI::Mojolicious;
25 Koha::REST::V1 - Main v.1 REST api class
33 Overloaded Mojolicious->startup method. It is called at application startup.
40 # Remove /api/v1/app.pl/ from the path
41 $self->hook( before_dispatch => sub {
42 shift->req->url->base->path('/');
45 # Force charset=utf8 in Content-Type header for JSON responses
46 $self->types->type( json => 'application/json; charset=utf8' );
48 $self->types->type( marcxml => 'application/marcxml+xml' );
49 $self->types->type( mij => 'application/marc-in-json' );
50 $self->types->type( marc => 'application/marc' );
53 my $secret_passphrase = C4::Context->config('api_secret_passphrase');
54 if ($secret_passphrase) {
55 $self->secrets([$secret_passphrase]);
58 my $validator = JSON::Validator::OpenAPI::Mojolicious->new;
59 $validator->load_and_validate_schema(
60 $self->home->rel_file("api/v1/swagger/swagger.json"),
62 allow_invalid_ref => 1,
66 push @{$self->routes->namespaces}, 'Koha::Plugin';
68 my $spec = $validator->schema->data;
70 'Koha::REST::Plugin::PluginRoutes' => {
72 validator => $validator
79 route => $self->routes->under('/api/v1')->to('Auth#under'),
81 1, # required by our spec because $ref directly under
82 # Paths-, Parameters-, Definitions- & Info-object
83 # is not allowed by the OpenAPI specification.
87 $self->plugin( 'Koha::REST::Plugin::Pagination' );
88 $self->plugin( 'Koha::REST::Plugin::Query' );
89 $self->plugin( 'Koha::REST::Plugin::Objects' );