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.
20 use Mojo::Base 'Mojolicious';
23 use JSON::Validator::OpenAPI::Mojolicious;
27 Koha::REST::V1 - Main v.1 REST api class
35 Overloaded Mojolicious->startup method. It is called at application startup.
42 # Remove /api/v1/app.pl/ from the path
43 $self->hook( before_dispatch => sub {
44 shift->req->url->base->path('/');
47 # Force charset=utf8 in Content-Type header for JSON responses
48 $self->types->type(json => 'application/json; charset=utf8');
50 my $secret_passphrase = C4::Context->config('api_secret_passphrase');
51 if ($secret_passphrase) {
52 $self->secrets([$secret_passphrase]);
55 my $validator = JSON::Validator::OpenAPI::Mojolicious->new;
56 $validator->load_and_validate_schema(
57 $self->home->rel_file("api/v1/swagger/swagger.json"),
59 allow_invalid_ref => 1,
63 push @{$self->routes->namespaces}, 'Koha::Plugin';
65 my $spec = $validator->schema->data;
67 'Koha::REST::Plugin::PluginRoutes' => {
69 validator => $validator
76 route => $self->routes->under('/api/v1')->to('Auth#under'),
78 1, # required by our spec because $ref directly under
79 # Paths-, Parameters-, Definitions- & Info-object
80 # is not allowed by the OpenAPI specification.
84 $self->plugin( 'Koha::REST::Plugin::Pagination' );
85 $self->plugin( 'Koha::REST::Plugin::Query' );
86 $self->plugin( 'Koha::REST::Plugin::Objects' );