Bug 14747

Summary: RESTful API with reverse proxy configuration
Product: Koha Reporter: Julian Maurice <julian.maurice>
Component: Web servicesAssignee: Olli-Antti Kivilahti <olli-antti.kivilahti>
Status: CLOSED WONTFIX QA Contact: Testopia <testopia>
Severity: enhancement    
Priority: P5 - low CC: chris, josef.moravec
Version: Main   
Hardware: All   
OS: All   
Change sponsored?: --- Patch complexity: Medium patch
Documentation contact: Documentation submission:
Text to go in the release notes:
Version(s) released in:
Bug Depends on: 13799, 14448    
Bug Blocks:    
Attachments: Bug 14747: RESTful API with reverse proxy configuration

Description Julian Maurice 2015-08-27 17:04:18 UTC
RESTful API with reverse proxy configuration
Comment 1 Julian Maurice 2015-08-27 17:10:06 UTC
Created attachment 42040 [details] [review]
Bug 14747: RESTful API with reverse proxy configuration

OPTIONAL replacement to the
    Bug 13799: RESTful API with Mojolicious and Swagger2
httpd-configuration.

Instead of having to go to your dns-provider, you can run the api from
your current virtualhost.

Use these configurations to reverse proxy www.host.domain/v1/ to the
REST API.

---------------------------
:INSTALLATION INSTRUCTIONS:
---------------------------

You need
    Bug 14448: Adding the REST API as a Hypnotoad service, koha-api-daemon.
to deploy the backend Mojolicous application as a FastCGI-daemon.

Then add the modifications from etc/koha-httpd.conf
to your /etc/apache2/sites-enabled/koha.conf
and adjust paths to fit.

..$ a2enmod proxy
..$ a2enmod proxy_http
..$ service apache2 restart

Much recommended is
    Bug 14458: Add SwaggerUI documentation for RESTful API
to browse your API capabilities.

Then just go to
    /v1/doc
to see the API autodocumentation.
Comment 2 Zeno Tajoli 2015-09-01 08:20:45 UTC
Patch complexity is 'Medium' because this change has many architectural connections
Comment 3 Josef Moravec 2017-06-14 08:39:53 UTC
Closing because dependency bug 14448 is also closed with WONTFIX