Go API client for gamesdb
API Documentation
Overview
This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.
- API version: 2.0.0
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen
Installation
Install the following dependencies:
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
Put the package under your project folder and add the following in import:
import gamesdb "github.com/J-Swift/thegamesdb-swagger-client-go"
To use a proxy, set the environment variable HTTP_PROXY
:
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
Configuration of Server URL
Default configuration comes with Servers
field that contains server objects as defined in the OpenAPI specification.
Select Server Configuration
For using other server than the one defined on index 0 set context value sw.ContextServerIndex
of type int
.
ctx := context.WithValue(context.Background(), gamesdb.ContextServerIndex, 1)
Templated Server URL
Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables
of type map[string]string
.
ctx := context.WithValue(context.Background(), gamesdb.ContextServerVariables, map[string]string{
"basePath": "v2",
})
Note, enum values are always validated and all unused variables are silently ignored.
URLs Configuration per Operation
Each operation can use different server URL defined using OperationServers
map in the Configuration
.
An operation is uniquely identified by "{classname}Service.{nickname}"
string.
Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices
and sw.ContextOperationServerVariables
context maps.
ctx := context.WithValue(context.Background(), gamesdb.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), gamesdb.ContextOperationServerVariables, map[string]map[string]string{
"{classname}Service.{nickname}": {
"port": "8443",
},
})
Documentation for API Endpoints
All URIs are relative to https://api.thegamesdb.net
Class | Method | HTTP request | Description |
---|---|---|---|
DevelopersApi | Developers | Get /v1/Developers | Fetch Developers list |
GamesApi | GamesByGameID | Get /v1/Games/ByGameID | Fetch game(s) by id |
GamesApi | GamesByGameName | Get /v1.1/Games/ByGameName | Fetch game(s) by name |
GamesApi | GamesByGameNameV1 | Get /v1/Games/ByGameName | Fetch game(s) by name |
GamesApi | GamesByPlatformID | Get /v1/Games/ByPlatformID | Fetch game(s) by platform id |
GamesApi | GamesImages | Get /v1/Games/Images | Fetch game(s) images by game(s) id |
GamesApi | GamesUpdates | Get /v1/Games/Updates | Fetch games update |
GenresApi | Genres | Get /v1/Genres | Fetch Genres list |
PlatformsApi | Platforms | Get /v1/Platforms | Fetch platforms list |
PlatformsApi | PlatformsByPlatformID | Get /v1/Platforms/ByPlatformID | Fetch platforms list by id |
PlatformsApi | PlatformsByPlatformName | Get /v1/Platforms/ByPlatformName | Fetch platforms by name |
PlatformsApi | PlatformsImages | Get /v1/Platforms/Images | Fetch platform(s) images by platform(s) id |
PublishersApi | Publishers | Get /v1/Publishers | Fetch Publishers list |
Documentation For Models
- BaseApiResponse
- Developer
- Developers
- DevelopersAllOf
- DevelopersAllOfData
- Game
- GameImage
- GamesByGameID
- GamesByGameIDAllOf
- GamesByGameIDAllOfData
- GamesByGameIDAllOfInclude
- GamesByGameIDAllOfIncludeBoxart
- GamesByGameIDAllOfIncludePlatform
- GamesByGameIDV1
- GamesByGameIDV1AllOf
- GamesByGameIDV1AllOfInclude
- GamesImages
- GamesImagesAllOf
- GamesImagesAllOfData
- GamesUpdates
- GamesUpdatesAllOf
- GamesUpdatesAllOfData
- Genre
- Genres
- GenresAllOf
- GenresAllOfData
- ImageBaseUrlMeta
- PaginatedApiResponse
- PaginatedApiResponseAllOf
- PaginatedApiResponseAllOfPages
- Platform
- PlatformImage
- PlatformSkinny
- Platforms
- PlatformsAllOf
- PlatformsAllOfData
- PlatformsByPlatformID
- PlatformsByPlatformName
- PlatformsByPlatformNameAllOf
- PlatformsByPlatformNameAllOfData
- PlatformsImages
- PlatformsImagesAllOf
- PlatformsImagesAllOfData
- Publisher
- Publishers
- PublishersAllOf
- PublishersAllOfData
- UpdateModel
Documentation For Authorization
Endpoints do not require authorization.
Documentation for Utility Methods
Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:
PtrBool
PtrInt
PtrInt32
PtrInt64
PtrFloat
PtrFloat32
PtrFloat64
PtrString
PtrTime