Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pokeapi/pokeapi
The Pokémon API
https://github.com/pokeapi/pokeapi
api beginner-friendly graphql hacktoberfest pokeapi pokemon
Last synced: about 1 month ago
JSON representation
The Pokémon API
- Host: GitHub
- URL: https://github.com/pokeapi/pokeapi
- Owner: PokeAPI
- License: bsd-3-clause
- Created: 2014-12-04T10:17:17.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-04-08T14:06:07.000Z (7 months ago)
- Last Synced: 2024-04-13T18:12:41.792Z (7 months ago)
- Topics: api, beginner-friendly, graphql, hacktoberfest, pokeapi, pokemon
- Language: Python
- Homepage: https://pokeapi.co
- Size: 34 MB
- Stars: 3,942
- Watchers: 74
- Forks: 908
- Open Issues: 135
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://circleci.com/gh/PokeAPI/pokeapi)
[](https://github.com/PokeAPI/api-data)
[](https://github.com/PokeAPI/deploy)
[](https://github.com/PokeAPI/pokeapi/blob/master/LICENSE.md)
[](https://opencollective.com/pokeapi)
[](https://opencollective.com/pokeapi)
A RESTful API for Pokémon - [pokeapi.co](https://pokeapi.co)
> Beta GraphQL support is rolling out! Check out the [GraphQL paragraph](#graphql--) for more info.
## Setup [](https://www.python.org/download/releases/3.10/)
- Download this source code into a working directory, be sure to use the flag `--recurse-submodules` to clone also our submodules.
- Install the requirements using pip:
```sh
make install
# This will install all the required packages and libraries for using PokeAPI
```
- Set up the local development environment using the following command:
```sh
make setup
```
- Run the server on port `8000` using the following command:
```sh
make serve
```
### Database setup
To build or rebuild the database by applying any CSV file update, run
```sh
make build-db
```
Visit [localhost:8000/api/v2/](http://localhost:8000/api/v2/) to see the running API!
Each time the `build-db` script is run, it will iterate over each table in the database, wipe it, and rewrite each row using the data found in data/v2/csv.
If you ever need to wipe the database use this command:
```sh
make wipe-sqlite-db
```
If the database schema has changed, generate any outstanding migrations and apply them
```sh
make make-migrations
make migrate
```
Run `make help` to see all tasks.
## Docker and Compose [](https://hub.docker.com/r/pokeapi/pokeapi)
There is also a multi-container setup, managed by [Docker Compose V2](https://docs.docker.com/compose/). This setup allows you to deploy a production-like environment, with separate containers for each service, and is recommended if you need to simply spin up PokéAPI.
Start everything by
```sh
make docker-setup
```
If you don't have `make` on your machine you can use the following commands
```sh
docker compose up -d
docker compose exec -T app python manage.py migrate --settings=config.docker-compose
docker compose exec -T app sh -c 'echo "from data.v2.build import build_all; build_all()" | python manage.py shell --settings=config.docker-compose'
```
Browse [localhost/api/v2/](http://localhost/api/v2/) or [localhost/api/v2/pokemon/bulbasaur/](http://localhost/api/v2/pokemon/bulbasaur/) on port `80`.
To rebuild the database and apply any CSV file updates, run
```sh
make docker-build-db
```
If the database schema has changed, generate the migrations and apply those
```sh
make docker-make-migrations
make docker-migrate
```
## GraphQL 
When you start PokéAPI with the above Docker Compose setup, an [Hasura Engine](https://github.com/hasura/graphql-engine) server is started as well. It's possible to track all the PokeAPI tables and foreign keys by simply
```sh
# hasura cli needs to be installed and available in your $PATH: https://hasura.io/docs/latest/graphql/core/hasura-cli/install-hasura-cli.html
# hasura cli's version has to greater than v2.0.8
make hasura-apply
```
When finished browse http://localhost:8080 and you will find the admin console. The GraphQL endpoint will be hosted at http://localhost:8080/v1/graphql.
A free public GraphiQL console is browsable at the address https://beta.pokeapi.co/graphql/console/. The relative GraphQL endpoint is accessible at https://beta.pokeapi.co/graphql/v1beta
A set of examples is provided in the directory [/graphql/examples](./graphql/examples) of this repository.
## Kubernetes [](https://github.com/PokeAPI/pokeapi/actions/workflows/docker-k8s.yml)
[Kustomize](https://kubernetes.io/docs/tasks/manage-kubernetes-objects/kustomization/) files are provided in the folder https://github.com/PokeAPI/pokeapi/tree/master/Resources/k8s/kustomize/base/. Create and change your secrets:
```sh
cp Resources/k8s/kustomize/base/secrets/postgres.env.sample Resources/k8s/kustomize/base/secrets/postgres.env
cp Resources/k8s/kustomize/base/secrets/graphql.env.sample Resources/k8s/kustomize/base/secrets/graphql.env
cp Resources/k8s/kustomize/base/config/pokeapi.env.sample Resources/k8s/kustomize/base/config/pokeapi.env
# Edit the newly created files
```
Configure `kubectl` to point to a cluster and then run the following commands to start a PokéAPI service.
```sh
kubectl apply -k Resources/k8s/kustomize/base/
kubectl config set-context --current --namespace pokeapi # (Optional) Set pokeapi ns as the working ns
# Wait for the cluster to spin up
kubectl exec --namespace pokeapi deployment/pokeapi -- python manage.py migrate --settings=config.docker-compose # Migrate the DB
kubectl exec --namespace pokeapi deployment/pokeapi -- sh -c 'echo "from data.v2.build import build_all; build_all()" | python manage.py shell --settings=config.docker-compose' # Build the db
kubectl wait --namespace pokeapi --timeout=120s --for=condition=complete job/load-graphql # Wait for Graphql configuration job to finish
```
This k8s setup creates all k8s resources inside the _Namespace_ `pokeapi`, run `kubectl delete namespace pokeapi` to delete them. It also creates a _Service_ of type `LoadBalancer` which is exposed on port `80` and `443`. Data is persisted on `12Gi` of `ReadWriteOnce` volumes.
## Wrappers
| Official wrapper | Repository | Features |
| --- | --- | --- |
| Node server-side | [PokeAPI/pokedex-promise-v2](https://github.com/PokeAPI/pokedex-promise-v2) | _Auto caching_ |
| Browser client-side | [PokeAPI/pokeapi-js-wrapper](https://github.com/PokeAPI/pokeapi-js-wrapper) | _Auto caching_, _Image caching_ |
| Java/Kotlin | [PokeAPI/pokekotlin](https://github.com/PokeAPI/pokekotlin) | |
| Python 2/3 | [PokeAPI/pokepy](https://github.com/PokeAPI/pokepy) | _Auto caching_ |
| Python 3 | [PokeAPI/pokebase](https://github.com/PokeAPI/pokebase) | _Auto caching_, _Image caching_ |
|Wrapper|Repository|Features|
|---|---|---|
|.Net Standard |[mtrdp642/PokeApiNet](https://github.com/mtrdp642/PokeApiNet)|Auto caching |
|Dart|[prathanbomb/pokedart](https://github.com/prathanbomb/pokedart)| |
|Go|[mtslzr/pokeapi-go](https://github.com/mtslzr/pokeapi-go)|Auto caching |
|PHP |[lmerotta/phpokeapi](https://github.com/lmerotta/phpokeapi)|Auto caching, lazy loading |
|PowerShell|[Celerium/PokeAPI-PowerShellWrapper](https://github.com/Celerium/PokeAPI-PowerShellWrapper)| |
|Python|[beastmatser/aiopokeapi](https://github.com/beastmatser/aiopokeapi)|Auto caching, asynchronous |
|Ruby|[rdavid1099/poke-api-v2](https://github.com/rdavid1099/poke-api-v2)| |
|Rust|[lunik1/pokerust](https://gitlab.com/lunik1/pokerust)|Auto caching |
|Scala |[juliano/pokeapi-scala](https://github.com/juliano/pokeapi-scala)|Auto caching |
|Spring Boot |[dlfigueira/spring-pokeapi](https://github.com/dlfigueira/spring-pokeapi)|Auto caching |
|Swift |[kinkofer/PokemonAPI](https://github.com/kinkofer/PokemonAPI)| |
|Typescript server-side/client-side|[Gabb-c/Pokenode-ts](https://github.com/Gabb-c/pokenode-ts)|Auto caching |
## Donations
Help to keep PokéAPI running! If you're using PokéAPI as a teaching resource or for a project, consider sending us a donation to help keep the service up. We get 1+ billion requests a month!
Thank you to all our backers! [Become a backer](https://opencollective.com/pokeapi#backer)
## Join Us On Slack!
> **Warning**
> Currently no maintainer has enough free time to support the community on Slack. Our Slack is in an unmaintained status.
Have a question or just want to discuss new ideas and improvements? Hit us up on Slack. ~~Consider talking with us here before creating a new issue.~~
This way we can keep issues here a bit more organized and helpful in the long run. Be excellent to each other :smile:
[Sign up](https://join.slack.com/t/pokeapi/shared_invite/zt-2ampo6her-_tHSI3uOS65WzGypt7Y96w) easily!
Once you've signed up visit [PokéAPI on Slack](https://pokeapi.slack.com)
## Contributing
This project exists thanks to all the people who [contribute](https://github.com/PokeAPI/pokeapi/blob/master/CONTRIBUTING.md)
All contributions are welcome: bug fixes, data contributions, and recommendations.
Please see the [issues on GitHub](https://github.com/PokeAPI/pokeapi/issues) before you submit a pull request or raise an issue, someone else might have beat you to it.
To contribute to this repository:
- [Fork the project to your own GitHub profile](https://help.github.com/articles/fork-a-repo/)
- Download the forked project using git clone:
```sh
git clone --recurse-submodules [email protected]:/pokeapi.git
```
- Create a new branch with a descriptive name:
```sh
git checkout -b my_new_branch
```
- Write some code, fix something, and add a test to prove that it works. *No pull request will be accepted without tests passing, or without new tests if new features are added.*
- Commit your code and push it to GitHub
- [Open a new pull request](https://help.github.com/articles/creating-a-pull-request/) and describe the changes you have made.
- We'll accept your changes after review.
Simple!
## Deprecation
As of October 2018, the v1 API has been removed from PokéAPI. For more information, see [pokeapi.co/docs/v1.html](https://pokeapi.co/docs/v1.html).