README.md•4.31 kB
# gamebrain - Kotlin client library for GameBrain API
GameBrain API
## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://github.com/OAI/OpenAPI-Specification) from a remote server, you can easily generate an API client.
- API version: 1.0.1
- Package version: 1.0.2
- Generator version: 7.8.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.KotlinClientCodegen
## Requires
* Kotlin 1.7.21
* Gradle 7.5
## Build
First, create the gradle wrapper script:
```
gradle wrapper
```
Then, run:
```
./gradlew check assemble
```
This runs all tests and packages the library.
## Features/Implementation Notes
* Supports JSON inputs/outputs, File inputs, and Form inputs.
* Supports collection formats for query parameters: csv, tsv, ssv, pipes.
* Some Kotlin and Java types are fully qualified to avoid conflicts with types defined in OpenAPI definitions.
* Implementation of ApiClient is intended to reduce method counts, specifically to benefit Android targets.
<a id="documentation-for-api-endpoints"></a>
## Documentation for API Endpoints
All URIs are relative to *https://api.gamebrain.co/v1*
| Class | Method | HTTP request | Description |
| ------------ | ------------- | ------------- | ------------- |
| *DefaultApi* | [**detail**](docs/DefaultApi.md#detail) | **GET** /games/{id} | Get Game Details |
| *DefaultApi* | [**news**](docs/DefaultApi.md#news) | **GET** /games/{id}/news | Get Game News |
| *DefaultApi* | [**search**](docs/DefaultApi.md#search) | **GET** /games | Search Games |
| *DefaultApi* | [**similar**](docs/DefaultApi.md#similar) | **GET** /games/{id}/similar | Get Similar Games |
| *DefaultApi* | [**suggest**](docs/DefaultApi.md#suggest) | **GET** /games/suggestions | Get Game Suggestions |
<a id="documentation-for-models"></a>
## Documentation for Models
- [co.gamebrain.client.model.GameNewsItem](docs/GameNewsItem.md)
- [co.gamebrain.client.model.GameNewsResponse](docs/GameNewsResponse.md)
- [co.gamebrain.client.model.GameResponse](docs/GameResponse.md)
- [co.gamebrain.client.model.GameResponseOffersInner](docs/GameResponseOffersInner.md)
- [co.gamebrain.client.model.GameResponseOffersInnerPrice](docs/GameResponseOffersInnerPrice.md)
- [co.gamebrain.client.model.GameResponseOfficialStoresInner](docs/GameResponseOfficialStoresInner.md)
- [co.gamebrain.client.model.GameResponsePlatformsInner](docs/GameResponsePlatformsInner.md)
- [co.gamebrain.client.model.GameResponsePlaytime](docs/GameResponsePlaytime.md)
- [co.gamebrain.client.model.GameResponseRating](docs/GameResponseRating.md)
- [co.gamebrain.client.model.SearchResponse](docs/SearchResponse.md)
- [co.gamebrain.client.model.SearchResponseActiveFilterOptionsInner](docs/SearchResponseActiveFilterOptionsInner.md)
- [co.gamebrain.client.model.SearchResponseActiveFilterOptionsInnerValuesInner](docs/SearchResponseActiveFilterOptionsInnerValuesInner.md)
- [co.gamebrain.client.model.SearchResponseFilterOptionsInner](docs/SearchResponseFilterOptionsInner.md)
- [co.gamebrain.client.model.SearchResponseFilterOptionsInnerValuesInner](docs/SearchResponseFilterOptionsInnerValuesInner.md)
- [co.gamebrain.client.model.SearchResponseResultsInner](docs/SearchResponseResultsInner.md)
- [co.gamebrain.client.model.SearchResponseResultsInnerRating](docs/SearchResponseResultsInnerRating.md)
- [co.gamebrain.client.model.SearchResponseSorting](docs/SearchResponseSorting.md)
- [co.gamebrain.client.model.SearchResponseSortingOptionsInner](docs/SearchResponseSortingOptionsInner.md)
- [co.gamebrain.client.model.SearchSuggestionResponse](docs/SearchSuggestionResponse.md)
- [co.gamebrain.client.model.SearchSuggestionResponseResultsInner](docs/SearchSuggestionResponseResultsInner.md)
- [co.gamebrain.client.model.SimilarGamesResponse](docs/SimilarGamesResponse.md)
<a id="documentation-for-authorization"></a>
## Documentation for Authorization
Authentication schemes defined for the API:
<a id="apiKey"></a>
### apiKey
- **Type**: API key
- **API key parameter name**: api-key
- **Location**: URL query string
<a id="headerApiKey"></a>
### headerApiKey
- **Type**: API key
- **API key parameter name**: x-api-key
- **Location**: HTTP header
## Author
mail@gamebrain.co