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';
23 use JSON
::Validator
::OpenAPI
::Mojolicious
;
28 Koha::REST::V1 - Main v.1 REST api class
36 Overloaded Mojolicious->startup method. It is called at application startup.
44 before_dispatch
=> sub {
47 # Remove /api/v1/app.pl/ from the path
48 $c->req->url->base->path('/');
51 $c->res->headers->header( 'Access-Control-Allow-Origin' =>
52 C4
::Context
->preference('AccessControlAllowOrigin') )
53 if C4
::Context
->preference('AccessControlAllowOrigin');
57 # Force charset=utf8 in Content-Type header for JSON responses
58 $self->types->type( json
=> 'application/json; charset=utf8' );
60 $self->types->type( marcxml
=> 'application/marcxml+xml' );
61 $self->types->type( mij
=> 'application/marc-in-json' );
62 $self->types->type( marc
=> 'application/marc' );
64 my $secret_passphrase = C4
::Context
->config('api_secret_passphrase');
65 if ($secret_passphrase) {
66 $self->secrets([$secret_passphrase]);
69 my $validator = JSON
::Validator
::OpenAPI
::Mojolicious
->new;
71 push @
{$self->routes->namespaces}, 'Koha::Plugin';
73 # Try to load and merge all schemas first and validate the result just once.
76 $spec = $validator->bundle(
79 schema
=> $self->home->rel_file("api/v1/swagger/swagger.json")
84 'Koha::REST::Plugin::PluginRoutes' => {
88 ) unless C4
::Context
->needs_install; # load only if Koha is installed
93 route
=> $self->routes->under('/api/v1')->to('Auth#under'),
95 1, # required by our spec because $ref directly under
96 # Paths-, Parameters-, Definitions- & Info-object
97 # is not allowed by the OpenAPI specification.
102 # Validation of the complete spec failed. Resort to validation one-by-one
104 $validator->load_and_validate_schema(
105 $self->home->rel_file("api/v1/swagger/swagger.json"),
107 allow_invalid_ref
=> 1,
111 $spec = $validator->schema->data;
113 'Koha::REST::Plugin::PluginRoutes' => {
115 validator
=> $validator
117 ) unless C4
::Context
->needs_install; # load only if Koha is installed
122 route
=> $self->routes->under('/api/v1')->to('Auth#under'),
124 1, # required by our spec because $ref directly under
125 # Paths-, Parameters-, Definitions- & Info-object
126 # is not allowed by the OpenAPI specification.
131 $self->plugin( 'Koha::REST::Plugin::Pagination' );
132 $self->plugin( 'Koha::REST::Plugin::Query' );
133 $self->plugin( 'Koha::REST::Plugin::Objects' );
134 $self->plugin( 'Koha::REST::Plugin::Exceptions' );