Giter VIP home page Giter VIP logo

go-api's Introduction

package go-api

Package goapi provides types to facilitate the creation of RESTful API wrappers.

Usage

Creating Requests

Create a request structure that implements the Request interface for the desired endpoint.

// MyEndpoint will render as https://hostname.com/v1/my/endpoint
type MyEndpoint struct{}

func (e MyEndpoint) Scheme() string {
  return "https"
}

func (e MyEndpoint) Host() string {
  return "hostname.com"
}

func (e MyEndpoint) Version() int {
  return 1
}

func (e MyEndpoint) Path() string {
  return "my/endpoint"
}

Request Parameters

If an endpoint accepts URL query parameters, specify them by creating a structure that implements the RequestParameters interface. It's your responsibility to do something with the additional values parameter, av.

type MyEndpointParameters struct {
  Foo string
}

func (p MyEndpointParameters) URLValues(av map[string]string) *url.Values {
  v := new(url.Values)

  if len(p.Foo) > 0 {
    v.Add("foo", p.Foo)
  }

  for key, value := range av {
    v.Add(key, value)
  }

  return nil
}

Performing Requests

Create an APIClient and give it a request and some, optional, request parameters.

c := goapi.NewAPIClient()
request := goapi.NewRequest(http.MethodGet, MyEndpoint{})
requestParameters := MyEndpointParameters{Foo: "bar"}

httpResponse, err := c.api.PerformRequest(
  request,
  requestParameters,
  nil,
)

If you have a custom response type, you can use the PerformUnmarshalRequest.

var responseData []string

httpResponse, err := c.api.PerformUnmarshalRequest(
  request,
  requestParameters,
  nil,
  &responseData,
)

go-api's People

Contributors

colinc86 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.