Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexandrecarlton/pokeapi-dump
NGINX dump of pokeapi.co
https://github.com/alexandrecarlton/pokeapi-dump
Last synced: about 1 month ago
JSON representation
NGINX dump of pokeapi.co
- Host: GitHub
- URL: https://github.com/alexandrecarlton/pokeapi-dump
- Owner: AlexandreCarlton
- Created: 2023-12-29T23:01:13.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-12-11T16:43:11.000Z (about 1 month ago)
- Last Synced: 2024-12-11T17:24:49.705Z (about 1 month ago)
- Language: Shell
- Size: 11.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# PokeAPI dump
A dump of the `pokeapi.co` packaged in an NGINX server for improved latency.
Only look-up by ID or namess are supported - no pagination is offered.
To spin this up and use it, run:
```bash
docker run --rm -it \
-p 8080:80 \
-e ENDPOINT=http://localhost:8080 \
docker.io/alexandrecarlton/pokeapi-dump:latest
curl http://localhost:8080/pokemon/1/
```
## Motivation
The existing endpoint contains a wealth of data but it is locked behind an
remote endpoint, introducing a non-negligible latency cost.
Furthermore, spinning this up locally requires multiple services and a python installation.
If we are only interested in look-up by ID/name, we can build something much simpler
and faster.
## How does this work?
We:
- fire up a local instance.
- trawl through the endpoints, dumping the contents into `.json` files.
- package this into an NGINX server which can serve this data with ease.
## Limitations
- Pagination parameters are not supported (e.g. `/pokemon?offset=20&limit=10`
will simply return the entire result set).
- Path `/pokemon/{id or name}/encounters` not supported.
- Look-up by name for data that share the same name may return different data to
the original (e.g. they may contain different IDs).
# Running
## Dump
### Requirements
- `curl`
- `docker-compose`
- `parallel`
- `jq`
### Running
Run:
```sh
# Spin up local instance of pokapi
make pokeapi-up
# Produce dump of JSON files
make dump
```
The contents of the dump will be stored in `./dump`.
Upon updating the [`pokeapi`] submodule, it may be necessary to clear all
volumes (in case of a database upgrade) - this can be done with
```sh
docker compose -f ... down --volumes
```
## Server
### Requirements
- `docker`
### Running
```bash
docker build -t pokeapi-dump .
docker run --rm -it \
-p 8080:80 \
-e ENDPOINT=http://localhost:8080 \
pokeapi-dump
```
# Results
We compare the local implementation (first) with our NGINX server (second) to
get a rough estimate of the gains achieved:
```
❯ hyperfine --runs 50 --warmup 3 "curl -L http://localhost:80/api/v2/pokemon/1/" "curl -L http://localhost:8081/pokemon/1/"
Benchmark 1: curl -L http://localhost:80/api/v2/pokemon/1/
Time (mean ± σ): 217.8 ms ± 14.2 ms [User: 1.9 ms, System: 2.1 ms]
Range (min … max): 207.7 ms … 265.2 ms 50 runs
Benchmark 2: curl -L http://localhost:8081/pokemon/1/
Time (mean ± σ): 4.2 ms ± 0.6 ms [User: 2.2 ms, System: 2.0 ms]
Range (min … max): 3.1 ms … 5.3 ms 50 runs
Summary
curl -L http://localhost:8081/pokemon/1/ ran
52.25 ± 7.91 times faster than curl -L http://localhost:80/api/v2/pokemon/1/
```
Of course, this comes at the cost of reduced functionality - but if all that is
needed is to look up pokemon data by id, this is a good place to start.