From 56853b919f43b5b8f595655e0943a281d77c40a8 Mon Sep 17 00:00:00 2001 From: Martin Schibel Date: Sat, 26 Sep 2020 23:54:11 +0200 Subject: [PATCH] fix documentation #3 --- app.js | 2 +- views/home.pug | 14 ++++++++------ 2 files changed, 9 insertions(+), 7 deletions(-) diff --git a/app.js b/app.js index 3e4961b..01674c6 100644 --- a/app.js +++ b/app.js @@ -230,8 +230,8 @@ app.get('/api/image/info/:id(\\d+)', imageController.imageInfo); const v1ImageController = require('./controllers/api/v1image'); app.get('/api/v1/image/:type/id/:id(\\d+)', v1ImageController.showImageById); -app.get('/api/v1/image/:type/wikidata/:id(\\d+)' , v1ImageController.showImageByWikidata); app.get('/api/v1/image/info/wikidata/:id(\\d+)' , v1ImageController.imageInfo); +app.get('/api/v1/image/:type/wikidata/:id(\\d+)' , v1ImageController.showImageByWikidata); // app.route('/images') // .get(imageController.getBooks) diff --git a/views/home.pug b/views/home.pug index 2c6e68a..18ec4b5 100644 --- a/views/home.pug +++ b/views/home.pug @@ -6,17 +6,19 @@ block content p Here you can upload pictures of Wikidata items, usually people. All images will be cropped using smart-crop to a resolution of 200 x 200 pixels. So it's best if you upload square photos. hr - h3 Request an image + h3 API version 1: Request an image div span Please use a valid Wikidata item id, without the Q. The returned image will be thumbnail with dimensions 200 x 200 pixels. ul li - a(href='/api/image/info/4115189') /api/image/info/$ID - small(style='margin-left:10px') Get Json info about a file + a(href='/api/v1/image/info/wikidata/4115189') /api/v1/image/info/wikidata/$ID + small(style='margin-left:10px') Get Json info about a file, $ID wikidata entity ID li - a(href='/api/getImage/4115189') /api/getImage/$ID - small(style='margin-left:10px') Get an image (return 404 on error) - + a(href='/api/v1/image/thumbnail/wikidata/4115189') /api/v1/image/thumbnail/wikidata/4115189 + small(style='margin-left:10px') Get an image using smartcrop (returns 404 on error) + li + a(href='/api/v1/image/facecrop/wikidata/4115189') /api/v1/image/facecrop/wikidata/4115189 + small(style='margin-left:10px') Get an image using facecrop (returns 404 on error) //.row // .col-md-6 // h2 Heading