meorphistest9

package module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 24, 2024 License: Apache-2.0 Imports: 10 Imported by: 0

README

Meorphis Test 9 Go API Library

Go Reference

The Meorphis Test 9 Go library provides convenient access to the Meorphis Test 9 REST API from applications written in Go. The full API of this library can be found in api.md.

Installation

import (
	"github.com/meorphis/test-repo" // imported as meorphistest9
)

Or to pin the version:

go get -u 'github.com/meorphis/test-repo@v0.1.0'

Requirements

This library requires Go 1.18+.

Usage

The full API of this library can be found in api.md.

package main

import (
	"context"
	"github.com/meorphis/test-repo"
)

func main() {
	client := meorphistest9.NewClient()
	err := client.Pets.New(context.TODO(), meorphistest9.PetNewParams{
		ID:   meorphistest9.F(int64(0)),
		Name: meorphistest9.F("string"),
	})
	if err != nil {
		panic(err.Error())
	}
}
Request Fields

All request parameters are wrapped in a generic Field type, which we use to distinguish zero values from null or omitted fields.

This prevents accidentally sending a zero value if you forget a required parameter, and enables explicitly sending null, false, '', or 0 on optional parameters. Any field not specified is not sent.

To construct fields with values, use the helpers String(), Int(), Float(), or most commonly, the generic F[T](). To send a null, use Null[T](), and to send a nonconforming value, use Raw[T](any). For example:

params := FooParams{
	Name: meorphistest9.F("hello"),

	// Explicitly send `"description": null`
	Description: meorphistest9.Null[string](),

	Point: meorphistest9.F(meorphistest9.Point{
		X: meorphistest9.Int(0),
		Y: meorphistest9.Int(1),

		// In cases where the API specifies a given type,
		// but you want to send something else, use `Raw`:
		Z: meorphistest9.Raw[int64](0.01), // sends a float
	}),
}
Response Objects

All fields in response structs are value types (not pointers or wrappers).

If a given field is null, not present, or invalid, the corresponding field will simply be its zero value.

All response structs also include a special JSON field, containing more detailed information about each property, which you can use like so:

if res.Name == "" {
	// true if `"name"` is either not present or explicitly null
	res.JSON.Name.IsNull()

	// true if the `"name"` key was not present in the repsonse JSON at all
	res.JSON.Name.IsMissing()

	// When the API returns data that cannot be coerced to the expected type:
	if res.JSON.Name.IsInvalid() {
		raw := res.JSON.Name.Raw()

		legacyName := struct{
			First string `json:"first"`
			Last  string `json:"last"`
		}{}
		json.Unmarshal([]byte(raw), &legacyName)
		name = legacyName.First + " " + legacyName.Last
	}
}

These .JSON structs also include an Extras map containing any properties in the json response that were not specified in the struct. This can be useful for API features not yet present in the SDK.

body := res.JSON.ExtraFields["my_unexpected_field"].Raw()
RequestOptions

This library uses the functional options pattern. Functions defined in the option package return a RequestOption, which is a closure that mutates a RequestConfig. These options can be supplied to the client or at individual requests. For example:

client := meorphistest9.NewClient(
	// Adds a header to every request made by the client
	option.WithHeader("X-Some-Header", "custom_header_info"),
)

client.Pets.New(context.TODO(), ...,
	// Override the header
	option.WithHeader("X-Some-Header", "some_other_custom_header_info"),
	// Add an undocumented field to the request body, using sjson syntax
	option.WithJSONSet("some.json.path", map[string]string{"my": "object"}),
)

The full list of request options is here.

Pagination

This library provides some conveniences for working with paginated list endpoints.

You can use .ListAutoPaging() methods to iterate through items across all pages:

// TODO

Or you can use simple .List() methods to fetch a single page and receive a standard response object with additional helper methods like .GetNextPage(), e.g.:

// TODO
Errors

When the API returns a non-success status code, we return an error with type *meorphistest9.Error. This contains the StatusCode, *http.Request, and *http.Response values of the request, as well as the JSON of the error body (much like other response objects in the SDK).

To handle errors, we recommend that you use the errors.As pattern:

_, err := client.Pets.New(context.TODO(), meorphistest9.PetNewParams{
	ID:   meorphistest9.F(int64(0)),
	Name: meorphistest9.F("string"),
})
if err != nil {
	var apierr *meorphistest9.Error
	if errors.As(err, &apierr) {
		println(string(apierr.DumpRequest(true)))  // Prints the serialized HTTP request
		println(string(apierr.DumpResponse(true))) // Prints the serialized HTTP response
	}
	panic(err.Error()) // GET "/pets": 400 Bad Request { ... }
}

When other errors occur, they are returned unwrapped; for example, if HTTP transport fails, you might receive *url.Error wrapping *net.OpError.

Timeouts

Requests do not time out by default; use context to configure a timeout for a request lifecycle.

Note that if a request is retried, the context timeout does not start over. To set a per-retry timeout, use option.WithRequestTimeout().

// This sets the timeout for the request, including all the retries.
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Minute)
defer cancel()
client.Pets.New(
	ctx,
	meorphistest9.PetNewParams{
		ID:   meorphistest9.F(int64(0)),
		Name: meorphistest9.F("string"),
	},
	// This sets the per-retry timeout
	option.WithRequestTimeout(20*time.Second),
)

Retries

Certain errors will be automatically retried 2 times by default, with a short exponential backoff. We retry by default all connection errors, 408 Request Timeout, 409 Conflict, 429 Rate Limit, and >=500 Internal errors.

You can use the WithMaxRetries option to configure or disable this:

// Configure the default for all requests:
client := meorphistest9.NewClient(
	option.WithMaxRetries(0), // default is 2
)

// Override per-request:
client.Pets.New(
	context.TODO(),
	meorphistest9.PetNewParams{
		ID:   meorphistest9.F(int64(0)),
		Name: meorphistest9.F("string"),
	},
	option.WithMaxRetries(5),
)
Middleware

We provide option.WithMiddleware which applies the given middleware to requests.

func Logger(req *http.Request, next option.MiddlewareNext) (res *http.Response, err error) {
	// Before the request
	start := time.Now()
	LogReq(req)

	// Forward the request to the next handler
	res, err = next(req)

	// Handle stuff after the request
	end := time.Now()
	LogRes(res, err, start - end)

    return res, err
}

client := meorphistest9.NewClient(
	option.WithMiddleware(Logger),
)

When multiple middlewares are provided as variadic arguments, the middlewares are applied left to right. If option.WithMiddleware is given multiple times, for example first in the client then the method, the middleware in the client will run first and the middleware given in the method will run next.

You may also replace the default http.Client with option.WithHTTPClient(client). Only one http client is accepted (this overwrites any previous client) and receives requests after any middleware has been applied.

Semantic Versioning

This package generally follows SemVer conventions, though certain backwards-incompatible changes may be released as minor versions:

  1. Changes to library internals which are technically public but not intended or documented for external use. (Please open a GitHub issue to let us know if you are relying on such internals).
  2. Changes that we do not expect to impact the vast majority of users in practice.

We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

We are keen for your feedback; please open an issue with questions, bugs, or suggestions.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Bool 

func Bool(value bool) param.Field[bool]

Bool is a param field helper which helps specify bools.

func F 

func F[T any](value T) param.Field[T]

F is a param field helper used to initialize a param.Field generic struct. This helps specify null, zero values, and overrides, as well as normal values. You can read more about this in our README.

func Float 

func Float(value float64) param.Field[float64]

Float is a param field helper which helps specify floats.

func Int 

func Int(value int64) param.Field[int64]

Int is a param field helper which helps specify integers. This is particularly helpful when specifying integer constants for fields.

func Null 

func Null[T any]() param.Field[T]

Null is a param field helper which explciitly sends null to the API.

func Raw 

func Raw[T any](value any) param.Field[T]

Raw is a param field helper for specifying values for fields when the type you are looking to send is different from the type that is specified in the SDK. For example, if the type of the field is an integer, but you want to send a float, you could do that by setting the corresponding field with Raw[int](0.5).

func String 

func String(value string) param.Field[string]

String is a param field helper which helps specify strings.

Types

type Client 

type Client struct {
	Options []option.RequestOption
	Pets    *PetService
}

Client creates a struct with services and top level methods that help with interacting with the meorphis-test-9 API. You should not instantiate this client directly, and instead use the NewClient method instead.

func NewClient 

func NewClient(opts ...option.RequestOption) (r *Client)

NewClient generates a new client with the default option read from the environment (). The option passed in as arguments are applied after these default arguments, and all option will be passed down to the services and requests that this client makes.

type Error 

type Error = apierror.Error

type Pet 

type Pet struct {
	ID   int64   `json:"id,required"`
	Name string  `json:"name,required"`
	Tag  string  `json:"tag"`
	JSON petJSON `json:"-"`
}

func (*Pet) UnmarshalJSON 

func (r *Pet) UnmarshalJSON(data []byte) (err error)

type PetListParams 

type PetListParams struct {
	// How many items to return at one time (max 100)
	Limit param.Field[int64] `query:"limit"`
}

func (PetListParams) URLQuery 

func (r PetListParams) URLQuery() (v url.Values)

URLQuery serializes PetListParams's query parameters as `url.Values`.

type PetNewParams 

type PetNewParams struct {
	ID   param.Field[int64]  `json:"id,required"`
	Name param.Field[string] `json:"name,required"`
	Tag  param.Field[string] `json:"tag"`
}

func (PetNewParams) MarshalJSON 

func (r PetNewParams) MarshalJSON() (data []byte, err error)

type PetService 

type PetService struct {
	Options []option.RequestOption
}

PetService contains methods and other services that help with interacting with the meorphis-test-9 API. Note, unlike clients, this service does not read variables from the environment automatically. You should not instantiate this service directly, and instead use the NewPetService method instead.

func NewPetService 

func NewPetService(opts ...option.RequestOption) (r *PetService)

NewPetService generates a new service that applies the given options to each request. These options are applied after the parent client's options (if there is one), and before any request-specific options.

func (*PetService) Get 

func (r *PetService) Get(ctx context.Context, petID string, opts ...option.RequestOption) (res *Pet, err error)

Info for a specific pet

func (*PetService) List 

func (r *PetService) List(ctx context.Context, query PetListParams, opts ...option.RequestOption) (res *Pets, err error)

List all pets

func (*PetService) New 

func (r *PetService) New(ctx context.Context, body PetNewParams, opts ...option.RequestOption) (err error)

Create a pet

type Pets 

type Pets []Pet

Source Files

View all Source files

Directories

Path Synopsis
apierror
apiform
apijson
apiquery
param
requestconfig
testutil

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.