ZXDB based Open API

This is the place for general discussion and updates about the ZXDB Database. This forum is not specific to Spectrum Computing.
User avatar
kolbeck
Dizzy
Posts: 50
Joined: Mon Nov 13, 2017 9:04 pm

ZXDB based Open API

Post by kolbeck » Sat Mar 10, 2018 11:24 am

The other ZXDB based website http//zxinfo.dk - is driven by an API based backend, which makes it possible to build other types of apps without the need to understand the SQL structure of ZXDB, installing required software such as SQL database and having to maintain your own running instance of ZXDB.

The idea behind the API from the beginning was to make a common foundation for accessing ZXDB information (it actually started when only W*S was available), that could be used for mutiple purposes - from simple lookup to full featured websites such as ZXInfo. Openess has been a key factor from the beginning, so the code is available on Github and it is implemented on modern open source cross platform technologies such as NodeJS, Express-JS, REST, Swagger.

The current API behind ZXInfo is a swagger documented REST API, which you can access there:

http://api.zxinfo.dk/doc/

And the acutal code can be found on Github https://github.com/thomasheckmann/zxinfo-services, as with the code behind the ZXInfo website.

With this post I would like to open up for discussion of future requirements of such API, if it should be used by more than just my own website. What does it take to bring the API to a more community driven API for accessing ZXDB data?
7 x
https://zxinfo.dk - another ZXDB frontend
https://api.zxinfo.dk/doc/ - ZXDB API for developers

hikoki
Manic Miner
Posts: 251
Joined: Thu Nov 16, 2017 10:54 am

Re: ZXDB based Open API

Post by hikoki » Sun Mar 11, 2018 3:47 am

Hi Thomas. Is there a way to sort new releases by date? year-month-day
1 x

User avatar
Nomad
Manic Miner
Posts: 600
Joined: Thu Dec 28, 2017 12:38 pm

Re: ZXDB based Open API

Post by Nomad » Sun Mar 11, 2018 4:41 am

Just throwing it out there but being able to restrict searches to one language only would be fantastic.
1 x

User avatar
PeterJ
Site Admin
Posts: 692
Joined: Thu Nov 09, 2017 7:19 pm
Location: Surrey, UK

Re: ZXDB based Open API

Post by PeterJ » Sun Mar 11, 2018 8:06 am

This looks great @kolbeck . Bringing ZXDB to a wider audience is fantastic.
1 x

hikoki
Manic Miner
Posts: 251
Joined: Thu Nov 16, 2017 10:54 am

Re: ZXDB based Open API

Post by hikoki » Sun Mar 11, 2018 1:29 pm

hikoki wrote:
Sun Mar 11, 2018 3:47 am
Hi Thomas. Is there a way to sort new releases by date? year-month-day
Apart from Updates sorted by date, it would be nice getting a number of random games from any result list. Something like display only 5 random games from any narrowed query.
1 x

User avatar
kolbeck
Dizzy
Posts: 50
Joined: Mon Nov 13, 2017 9:04 pm

Re: ZXDB based Open API

Post by kolbeck » Mon Mar 12, 2018 7:52 am

hikoki wrote:
Sun Mar 11, 2018 1:29 pm
hikoki wrote:
Sun Mar 11, 2018 3:47 am
Hi Thomas. Is there a way to sort new releases by date? year-month-day
Apart from Updates sorted by date, it would be nice getting a number of random games from any result list. Something like display only 5 random games from any narrowed query.
The frontpage of ZXInfo already does that but it's not part of the API. Putting it on the TODO list

https://github.com/thomasheckmann/zxinf ... s/issues/3

/Thomas
0 x
https://zxinfo.dk - another ZXDB frontend
https://api.zxinfo.dk/doc/ - ZXDB API for developers

User avatar
kolbeck
Dizzy
Posts: 50
Joined: Mon Nov 13, 2017 9:04 pm

Re: ZXDB based Open API

Post by kolbeck » Mon Mar 12, 2018 7:53 am

hikoki wrote:
Sun Mar 11, 2018 3:47 am
Hi Thomas. Is there a way to sort new releases by date? year-month-day
Not yet - added to TODO list :-)

https://github.com/thomasheckmann/zxinf ... s/issues/4

/Thomas
0 x
https://zxinfo.dk - another ZXDB frontend
https://api.zxinfo.dk/doc/ - ZXDB API for developers

User avatar
kolbeck
Dizzy
Posts: 50
Joined: Mon Nov 13, 2017 9:04 pm

Re: ZXDB based Open API

Post by kolbeck » Mon Mar 12, 2018 7:55 am

Nomad wrote:
Sun Mar 11, 2018 4:41 am
Just throwing it out there but being able to restrict searches to one language only would be fantastic.
Great idea! Adding to TODO list

https://github.com/thomasheckmann/zxinf ... s/issues/5

/Thomas
0 x
https://zxinfo.dk - another ZXDB frontend
https://api.zxinfo.dk/doc/ - ZXDB API for developers

User avatar
kolbeck
Dizzy
Posts: 50
Joined: Mon Nov 13, 2017 9:04 pm

Re: ZXDB based Open API

Post by kolbeck » Tue Mar 20, 2018 10:49 pm

So.. after some input - the ZXInfo API has been updated.

* Added a compact view mode option for getGameById and Search making it more friendly on low-end devices
* General data cleanup, removing duplicate data etc.
* getGameId now accepts ID with less than 7 digits with improved error handling
* Fixed some endpoints preventing timeout if parameters offset or size not supplied
* Updated API documentation

More info including test page here: http://api.zxinfo.dk/doc/
4 x
https://zxinfo.dk - another ZXDB frontend
https://api.zxinfo.dk/doc/ - ZXDB API for developers

User avatar
kolbeck
Dizzy
Posts: 50
Joined: Mon Nov 13, 2017 9:04 pm

Re: ZXDB based Open API

Post by kolbeck » Wed Mar 21, 2018 11:37 am

kolbeck wrote:
Mon Mar 12, 2018 7:55 am
Nomad wrote:
Sun Mar 11, 2018 4:41 am
Just throwing it out there but being able to restrict searches to one language only would be fantastic.
Great idea! Adding to TODO list

https://github.com/thomasheckmann/zxinf ... s/issues/5

/Thomas
@Nomad Language filter has been implemented in API - http://api.zxinfo.dk/doc/#!/zxinfo/searchAndFilter
You can try it out on http://zxinfo.dk as well

/Thomas
2 x
https://zxinfo.dk - another ZXDB frontend
https://api.zxinfo.dk/doc/ - ZXDB API for developers

Post Reply