https://github.com/oapicf/pokeapi-clients

A set of generated API clients for Poké API from an OpenAPI v3 specification
https://github.com/oapicf/pokeapi-clients

little-godzilla oapicf openapi openapi-generator pokemon

Last synced: 9 months ago
JSON representation

A set of generated API clients for Poké API from an OpenAPI v3 specification

• Host: GitHub
• URL: https://github.com/oapicf/pokeapi-clients
• Owner: oapicf
• License: mit
• Created: 2022-02-28T09:12:16.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-11-04T23:44:29.000Z (about 1 year ago)
• Last Synced: 2025-04-15T20:12:38.234Z (9 months ago)
• Topics: little-godzilla, oapicf, openapi, openapi-generator, pokemon
• Language: C++
• Homepage:
• Size: 11.6 MB
• Stars: 4
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          


[![Build Status](https://github.com/oapicf/pokeapi-clients/actions/workflows/ci-workflow.yaml/badge.svg)](https://github.com/oapicf/pokeapi-clients/actions/workflows/ci-workflow.yaml)




PokéAPI Clients

---------------

PokéAPI Clients is a set of generated API clients for [Poké API](https://www.pokeapi.co/) from an OpenAPI v3 specification. Credit goes to [Niccolò Maltoni](https://github.com/NiccoMlt) for building [the baseline version of PokéAPI specification](https://gist.github.com/NiccoMlt/073b18934a6001fc5a2414c590e3b8ba).

The API clients are generated using [OpenAPI Generator](https://openapi-generator.tech/).

Published packages

------------------

| Language | Package | Status | Documentation |

|----------|---------|--------|---------------|

| JavaScript | [pokeapi-client]((http://www.npmjs.com/package/pokeapi-client)) | [![Published Version](https://img.shields.io/npm/v/pokeapi-client.svg)](http://www.npmjs.com/package/pokeapi-client) | [README](https://github.com/oapicf/pokeapi-client/blob/main/clients/javascript/generated/README.md) |

| Python | [pokeapiclient]((https://pypi.python.org/pypi/pokeapiclient)) | [![Published Version](https://img.shields.io/pypi/v/pokeapiclient.svg)](https://pypi.python.org/pypi/pokeapiclient) | [README](https://github.com/oapicf/pokeapi-client/blob/main/clients/python/generated/README.md) |

| Ruby | [pokeapi_client]((https://rubygems.org/gems/pokeapi_client)) | [![Published Version](https://img.shields.io/gem/v/pokeapi_client.svg)](https://rubygems.org/gems/pokeapi_client) | [README](https://github.com/oapicf/pokeapi-client/blob/main/clients/ruby/generated/README.md) |

Version matrix

--------------

Note: Version 0.9.0 returns response as String since the specification does not yet include any response schema.

| PokéAPI Clients Version | PokéAPI OpenAPI Spec Version | OpenAPI Version | OpenAPI Generator Version |

|-------------------------|------------------------------|-----------------|---------------------------|

| 1.1.0 | 20220523 | 3.0.0 | 7.6.0 |

| 1.0.0 | 20220523 | 3.0.0 | 7.4.0 |

| 0.10.0 | 20220523 | 3.0.0 | 6.0.1 |

| 0.9.1 | 20220523 | 3.0.0 | 5.4.0 |

Installation

------------

You can either use the generated clients from `clients//generated/` directory.

Or you can use the published packages like below:

Install JavaScript client:

    npm install pokeapi-client

Install Python client:

    pip install pokeapiclient

Install Ruby client:

    gem install pokeapi_client

Colophon

--------

* [API Documentation](https://oapicf.github.io/pokeapi-clients/api/latest/)