Document HTTP API

[ferronrsmith]

The Web API is nice. It would help if this was documented so that it can be integrated into other systems. I have a distributed FS and use filemanager has the front-end for all of this.

When a user is created in our system we create one in filemanager user with a scope. So that it acts like a multi-tenant system. It's beautiful. We had to read through the web app to + code find endpoints.

Should have been documented.

[hacdias]

😮 Yes, I have to write the docs for the web API. There was someone else who asked me the same too.

[singlaive]

It is 2020, please where is the doc?

[Alsan]

+1 for such doc.

[skaravad]

I'm not quite sure if anyone is already using API's , I tracked the API calls from chrome for few POST calls like create user, the tricky part was to get the auth cookie , once you have it you can just wire your own python/curl etc.

Get Auth Cookie:

cookie=`curl -Ss localhost:8001/api/login --data-raw '{"username":"admin","password":"admin"}'`
echo "Cookie: auth=$cookie" > /tmp/cookie
curl -H "$(cat /tmp/cookie)"  localhost:8001/api/users --data-raw '{"what":"user","which":[],"data":{"scope":".","hideDotfiles":true,"username":"testUser","password":"PASSWORD"}}'

[mckaygerhard]

i already have half documented the api by reverse way of interaction.. but i still waithing to the current merge request will be done @on4r thanks in advance

[gaby]

6 years later, still no docs. Is there some tool to auto-generate these?

[mckaygerhard]

@gaby the problem is the autor itselft.. it seems do not care about that

[RiverChu0]

2000 years later...

[icheered]

Is there already an update on the documentation? With a bunch of trial and error I managed to obtain the JWT token, but using it to authenticate has so far been impossible. This is the simple node script I wrote to try and download a testfile:

import axios from 'axios';
import fs from 'fs';

async function getToken() {
	const response = await axios.post('http://localhost:8080/api/login', {
		username: 'MY_USERNAME',
		password: 'MY_PASSWORD'
	});
	return response.data;
}

async function downloadFile(token) {
	const url = 'http://localhost:8080/api/resources/test';

	const response = await axios({
		method: 'GET',
		url: url,
		responseType: 'stream',
		headers: {
			Authorization: `Bearer ${token}`
		}
	});

	const writer = fs.createWriteStream('DownloadedTextFile.txt');

	response.data.pipe(writer);

	return new Promise((resolve, reject) => {
		writer.on('finish', resolve);
		writer.on('error', reject);
	});
}

async function main() {
	const token = await getToken();
	console.log('Token: ' + token);
	if (token) {
		await downloadFile(token);
	} else {
		console.log('No token. Aborting.');
	}
}

main().catch((e) => {
	console.error('Error: ', e);
});

This obtains a token, but when downloading the file using the token I get a '401 unauthorized' error.