Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/scraly/gophers-sdk-go
Go SDK to handle cute Gophers
https://github.com/scraly/gophers-sdk-go
sdk-go sdk-golang
Last synced: about 2 months ago
JSON representation
Go SDK to handle cute Gophers
- Host: GitHub
- URL: https://github.com/scraly/gophers-sdk-go
- Owner: scraly
- License: apache-2.0
- Created: 2023-07-16T08:56:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-17T15:24:24.000Z (over 1 year ago)
- Last Synced: 2024-05-01T21:50:38.949Z (8 months ago)
- Topics: sdk-go, sdk-golang
- Language: Shell
- Homepage: https://pkg.go.dev/github.com/scraly/gophers-sdk-go
- Size: 62.5 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Go API client for gopherssdkgo
HTTP server that handle cute Gophers.
## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.
- API version: 0.1.0
- Package version: 0.0.5
- Build package: org.openapitools.codegen.languages.GoClientCodegen
## Installation
Install the following dependencies:
```shell
go get github.com/stretchr/testify/assert
go get golang.org/x/net/context
```
Put the package under your project folder and add the following in import:
```golang
import gopherssdkgo "github.com/scraly/gophers-sdk-go"
```
To use a proxy, set the environment variable `HTTP_PROXY`:
```golang
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`.
```golang
ctx := context.WithValue(context.Background(), gopherssdkgo.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`.
```golang
ctx := context.WithValue(context.Background(), gopherssdkgo.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.
```golang
ctx := context.WithValue(context.Background(), gopherssdkgo.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), gopherssdkgo.ContextOperationServerVariables, map[string]map[string]string{
"{classname}Service.{nickname}": {
"port": "8443",
},
})
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost:8080*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*GophersApi* | [**CheckHealth**](docs/GophersApi.md#checkhealth) | **Get** /healthz |
*GophersApi* | [**GopherDelete**](docs/GophersApi.md#gopherdelete) | **Delete** /gopher |
*GophersApi* | [**GopherGet**](docs/GophersApi.md#gopherget) | **Get** /gopher |
*GophersApi* | [**GopherPost**](docs/GophersApi.md#gopherpost) | **Post** /gopher | Add a new Gopher
*GophersApi* | [**GopherPut**](docs/GophersApi.md#gopherput) | **Put** /gopher |
*GophersApi* | [**GophersGet**](docs/GophersApi.md#gophersget) | **Get** /gophers |
## Documentation For Models
- [Gopher](docs/Gopher.md)
- [GopherPutRequest](docs/GopherPutRequest.md)
## 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`
## Author