Add REST API

[oparoz]

General

• Versioning will happen using headers
• Authentication happens via HTTP auth

Config API

Gives information about the supported features as well as the list of supported media types

• /api/config

Files API

Gives the list of files found in the folder given as argument and lets you download a file

• /api/files/list
• /api/files/download/{fileId}

Preview API

Gives you a list of base64 encoded thumbnails when you connect to the thumbnails endpoint using EventSource and gives you a resized preview when you use the preview endpoint

• /api/preview/thumbnails
• /api/preview/{fileId}/{width}/{height}

[oparoz]

The API can be tested using Codeception.
You need to install Codeception via composer as we need a local web server to run during the test. See this doc for details: https://github.com/owncloud/gallery/blob/master/tests/README.MD#install-via-composer

Then you simply do:

# cd apps/gallery
# vendor/bin/codecept run api

If you need a more verbose output to check the scenarios, use:
# vendor/bin/codecept run api -vvv

[ghost]

@rperezb can someone have a look?

[rperezb]

@SergioBertolinSG may check this one, once he finishes with the encryption one

[oparoz]

@SergioBertolinSG - There is now some documentation for the API: https://github.com/owncloud/gallery/wiki/RESTful-API

[SergioBertolinSG]

@oparoz Awesome, thanks.

[oparoz]

I'm going to close this since the tests are used in CI.
We'll have a better idea of if it meets the needs of developers when they start using it.
Any missing, interesting test case, just add them directly to the tests or post new scenarios.