Skip to content

Latest commit

 

History

History
166 lines (120 loc) · 5.49 KB

README.md

File metadata and controls

166 lines (120 loc) · 5.49 KB
Raw

JSON API for Dataset Arte Electrónico Argentino

A very simple RESTful JSON API to query the dataset curated by @cristianReynaga, you can read more about it here (in spanish).
This API is built using Golang and SQLite3. I also provide a sanitised csv file ready to be imported to a sqlite db (with the necessary statements to ease the process).

This is a WIP with the intention to have a quick way to access this information and to keep learning golang :-)
It's publicly accessible here (For now http:// only):

How to ...?

Easy way

$ docker pull lvm23/api-arte-electronico-argentino
$ docker run -d -p 8080:8080 lvm23/api-arte-electronico-argentino

Manual way

As usual

$ git clone https://github.com/lvm/api-dataset-arte-electronico-argentino
$ cd api-dataset-arte-electronico-argentino/

Then, create the SQLite database

$ rm -f db/electronicArtArgentina.sqlite3
$ cd data
$ cat csv-to-sqlite | sqlite3 ../db/electronicArtArgentina.sqlite3

For testing purpose, to build the API (I recommend using the official golang image) you need to execute

$ export GOPATH=$HOME
$ go get .
$ go run

Note: api.go reads a couple of extra enviroment vars: HTTP_PORT (default: 8080), DB_FILENAME (default: ./db/electronicArtArgentina.sqlite3))

If everything went OK, you should see something like

[GIN-debug] [WARNING] Running in "debug" mode. Switch to "release" mode in production.
 - using env:   export GIN_MODE=release
 - using code:  gin.SetMode(gin.ReleaseMode)

[GIN-debug] GET    //exhibitions       --> main.GetExhibitions (4 handlers)
[GIN-debug] GET    /exhibitions/:e_id --> main.GetExhibition (4 handlers)
[GIN-debug] GET    /search            --> main.SearchExhibitions (4 handlers)
[GIN-debug] OPTIONS /exhibitions       --> main.EndpointsOptions (4 handlers)
[GIN-debug] OPTIONS /exhibitions/:e_id --> main.EndpointsOptions (4 handlers)
[GIN-debug] OPTIONS /search            --> main.EndpointsOptions (4 handlers)
[GIN-debug] Listening and serving HTTP on :8080

and you can start querying the API.
Note: If you export the GIN_MODE=release env var, those debug messages won't be displayed but it's recommended for production.
Also, you can take a look at the Dockerfile to get an idea of the steps required.

Endpoints

For the moment, there are two endpoints: exhibitions and search. It accepts only GET and OPTION requests.

endpoints

List all available endpoints

GET /

exhibitions

This method allows to query all of them or just one.

List all (around 15xx) exhibitions

GET /exhibitions

To retrieve more items, use the GET parameter ?page=n

Just one by passing the ID

GET /exhibitions/23

search

This method allows to search, primarily by the exhibition's name and then you can pass more parameters to narrow your search. These extra parameters use the AND operator when building the query.

param values
q The full name or a part of the name of an exhibition. Can be any string
year The valid format would be YYYY, but you can pass any int (32)
when Only takes since and until. They work as greater-than-equal and less-than-equal respectively
technique The name of a technique, can be any string.
curator The name of a curator, can be any string.
artist The name of an artist, can be any string.
work The name of the work, can be any string.
page The page #. Each page shows 20 items.

Examples

List all exhibitions with festival on its name

GET /search?q=festival

...during 1998

GET /search?q=festival&year=1998

...until 1998

GET /search?q=festival&year=1998&when=until

...since 1998

GET /search?q=festival&year=1998&when=since

...with technique videoart

GET /search?q=festival&year=1998&when=since&technique=videoart

...curated by Graciela Taquini

GET /search?q=festival&year=1998&when=since&technique=videoart&curator=taquini

...artist Joanna Rytel

GET /search?q=festival&year=1998&when=since&technique=videoart&curator=taquini&artist=rytel

...with the word sheep on its name

GET /search?q=festival&year=1998&when=since&technique=videoart&curator=taquini&artist=rytel&work=sheep

TODO

  • Pagination: cleaner way to create the paginationLinks
  • Pagination: Optimize SQLite (drop OFFSET and LIMIT, use INDEX)
  • Search by person (artists or curators)
  • configure https://

Bugs, contributions

Go here

LICENSE

See LICENSE