art-api: a REST API to manage artworks

This project was inspired on an anki deck that reunites 651 artworks. You can grab the data from https://ankiweb.net/shared/info/685421036 (maybe not all notes contain correct information, though).

In order to retrieve information of all cards, I made a Python script.

Technologies used:

• NodeJS / Express
• PostgreSQL
• Google Cloud storage for file storage
• Multer for uploading files
• File-type for file signature checking
• Docker for container isolation

How to use

First, clone this repository.

To perform actions such as creating and deleting the image files, you will need to set a bucket in google cloud storage. Do that in order to be able to use a key.json file - and change the URL redirected in the image router to that of your bucket.

After that, set the .env file and run docker-compose up. The database along with the tables will be created.

Note that the .env file must have the following structure:

APP_PORT = 
DB_USER = 
DB_HOST =
DB_PASSWORD =
DB_DATABASE=

Endpoints

There are three main routes: artwork, period and image.

• Artwork

Contains the fields id (automatically set), title, artist, year and file (a string referring to the name of corresponding uploaded file).

Example: /artwork/90/periods

Type	Endpoint	Description
GET	/	Shows all artworks. Requires limit and page query parameters.
GET	/:id	Info about artwork with given id.
GET	/:id/periods	Lists periods of artwork with given id.
PUT	/:id	Updates the fields of artwork with given id.
PUT	/:id/periods/:id	Lists periods of artwork with given id.
POST	/	Posts a new artwork. Requires multipart/form-data format.
DELETE	/:id	Deletes artwork with given id.
DELETE	/:id/periods/:id	Deletes artwork with given id.

• Period

Example: /period?page=0&limit=10

Type	Endpoint	Description
GET	/	Shows all periods. Requires limit and page query parameters.
GET	/:id/artworks	Shows all artworks of a given period.
PUT	/:id	Updates name of period with given id.
POST	/:id	Posts a new period.

• Image

Example: /image/90

Type	Endpoint	Description
GET	/:id	Shows the image corresponding to artwork with given id.