README
¶
component-httpclient - Settings component for generate HTTP clients
Overview
This is a settings component that enables
constructing a simple HTTP client.
Using SMART client from transportd configuration is no longer
supported as we no longer maintain transportd as of January 2024.
Quick Start
package main
import (
"context"
"net/http"
httpclient "github.com/asecurityteam/component-httpclient"
"github.com/asecurityteam/settings/v2"
)
func main() {
ctx := context.Background()
envSource := settings.NewEnvSource(os.Environ())
tr := httpclient.New(ctx, envSource)
c := &http.Client{
Transport: tr,
}
}
Status
This project is in incubation which means we are not yet operating this tool in production and the interfaces are subject to change.
Contributing
Building And Testing
We publish a docker image called SDCLI that bundles all of our build dependencies. It is used by the included Makefile to help make building and testing a bit easier. The following actions are available through the Makefile:
-
make dep
Install the project dependencies into a vendor directory
-
make lint
Run our static analysis suite
-
make test
Run unit tests and generate a coverage artifact
-
make integration
Run integration tests and generate a coverage artifact
-
make coverage
Report the combined coverage for unit and integration tests
License
This project is licensed under Apache 2.0. See LICENSE.txt for details.
Contributing Agreement
Atlassian requires signing a contributor's agreement before we can accept a patch. If you are an individual you can fill out the individual CLA. If you are contributing on behalf of your company then please fill out the corporate CLA.
Documentation
¶
Index ¶
Constants ¶
const ( // TypeDefault is used to select the default Go HTTP client. TypeDefault = "DEFAULT" // TypeSmart is used to select the transportd HTTP client. // Deprecated: TypeSmart is no longer available as we no longer maintain transportd TypeSmart = "SMART" )
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Component ¶
type Component struct {
Default *DefaultComponent
}
Component is the top level HTTP client component.
func NewComponent ¶
func NewComponent() *Component
NewComponent populates an HTTPComponent with defaults.
type Config ¶
type Config struct {
Type string `description:"The type of HTTP client. Choices are SMART and DEFAULT."`
Default *DefaultConfig
}
Config wraps all HTTP related settings.
type DefaultComponent ¶
type DefaultComponent struct{}
DefaultComponent is a component for creating the default Go HTTP client.
func (*DefaultComponent) New ¶
func (*DefaultComponent) New(ctx context.Context, conf *DefaultConfig) (http.RoundTripper, error)
New constructs a client from the given configuration
func (*DefaultComponent) Settings ¶
func (*DefaultComponent) Settings() *DefaultConfig
Settings returns the default configuration.
type DefaultConfig ¶
type DefaultConfig struct {
ContentType string
}
DefaultConfig contains all settings for the default Go HTTP client.
type RoundTripper ¶
type RoundTripper = http.RoundTripper
RoundTripper is the interface that handles all HTTP operations. It is almost exclusively used with an http.Client wrapped around it. This is included here for documentation purposes only.
Source Files