Skip to content

Quick Start

Installation

bash
go get github.com/cybergodev/httpc

Basic Requests

No need to create a client - use package-level functions directly:

go
package main

import (
    "fmt"
    "log"

    "github.com/cybergodev/httpc"
)

func main() {
    result, err := httpc.Get("https://httpbin.org/get")
    if err != nil {
        log.Fatal(err)
    }

    fmt.Println(result.StatusCode()) // 200
    fmt.Println(result.Body())       // Response body
}

Supported HTTP methods: Get, Post, Put, Patch, Delete, Head, Options.

Creating a Client

When you need custom configuration, create a client instance:

go
client, err := httpc.New()
if err != nil {
    log.Fatal(err)
}
defer client.Close()

result, err := client.Get("https://httpbin.org/get")

Configuration Presets

ConfigurationPurposeFeatures
DefaultConfig()General purposeSecure defaults, SSRF protection enabled
SecureConfig()Security-sensitive scenariosDisables auto-redirect, strict timeouts
PerformanceConfig()High throughput scenariosLarge connection pool, long timeouts, cookies enabled
TestingConfig()Test environmentsDisables security checks and HTTP/2, enables cookies
MinimalConfig()Lightweight requestsNo retries, no redirects
go
cfg := httpc.DefaultConfig()
cfg.Timeouts.Request = 60 * time.Second

client, err := httpc.New(cfg)

Response Handling

go
result, err := client.Get("https://httpbin.org/json")
if err != nil {
    log.Fatal(err)
}

// Status check
result.StatusCode()     // 200
result.IsSuccess()      // true (2xx)
result.IsClientError()  // false (4xx)
result.IsServerError()  // false (5xx)

// JSON parsing
var data map[string]any
if err := result.Unmarshal(&data); err != nil {
    log.Fatal(err)
}

Sending Data

go
// JSON
result, err := client.Post("https://httpbin.org/post",
    httpc.WithJSON(map[string]any{"name": "test"}),
)
go
// Form
result, err := client.Post("https://httpbin.org/post",
    httpc.WithForm(map[string]string{"username": "admin"}),
)
go
// With authentication
result, err := client.Get("https://api.example.com/data",
    httpc.WithBearerToken("my-token"),
)

Error Handling

HTTPC distinguishes between network-level errors and HTTP status codes:

go
result, err := client.Get("https://api.example.com/data")
if err != nil {
    var clientErr *httpc.ClientError
    if errors.As(err, &clientErr) {
        log.Printf("Error code: %s", clientErr.Code())
    }
    log.Fatal(err)
}

// HTTP status codes need manual checking
switch {
case result.IsSuccess():
    // 2xx success
case result.IsClientError():
    log.Printf("Client error: %d", result.StatusCode())
case result.IsServerError():
    log.Printf("Server error: %d", result.StatusCode())
}

TIP

4xx/5xx are not returned as error. Check them via result.IsSuccess() and similar methods. See Error Handling for details.

Next Steps