Readme.md

Web Request for Go Packages

What is this?

This is module to help you make web requests in Go, it is a wrapper around the standard library's http package. You can use Get or Post to make a request, and then use the Response object to get the response body, headers, status code, etc.

Example

package main

import (
    "fmt"
    "github.com/tonnytg/webreq"
)

func main() {
    request := webreq.NewRequest("GET")
    request.SetURL("https://example.com")
    request.SetTimeout(10)

    // Execute the request and get the response
    response, err := request.Execute()
    if err != nil {
        fmt.Println("Error executing request:", err)
        return
    }
}

Why

So many times I needed to make a request in an API and after convert body to struct, and every time I needed to configure http.Client and put headers and body. Thinking about "don't repeat your self" I believe this unified code can gain time build an easy way to make this request.

What do you think? Liked, set star in this project to help me to help others!

Using only Http Get

client := &http.Client{
    Timeout: 10 * time.Second,
}

req, err := http.NewRequest("GET", "https://api.example.com/data", nil)
if err != nil {
    fmt.Println("Error creating request:", err)
    return
}
req.Header.Add("Authorization", "Bearer your_token")

resp, err := client.Do(req)
if err != nil {
    fmt.Println("Error executing request:", err)
    return
}
defer resp.Body.Close()

body, err := io.ReadAll(resp.Body)
if err != nil {
    fmt.Println("Error reading response body:", err)
    return
}
fmt.Println("Response:", string(body))

Using WebReq

var headers = make(map[string]string)
headers["Content-Type"] = "application/json"
headers["Authorization"] = "Bearer your_token"

request := webreq.NewRequest("POST")
request.SetURL("https://api.example.com/data")
request.SetData([]byte(`{"key":"value"}`))
request.SetHeaders(headers.Headers)
request.SetTimeout(10)

response, err := request.Execute()
if err != nil {
    fmt.Println("Error executing request:", err)
    return
}
fmt.Println("Response:", string(response))

Install

go get github.com/tonnytg/webreq

Basic Usage

Get

Create a slice of headers to use and input in request

package main

import (
    "fmt"
    "github.com/tonnytg/webreq"
)

func main() {
    request := webreq.NewRequest("GET")
    request.SetURL("https://example.com")

    // Execute the request and get the response
    response, err := request.Execute()
    if err != nil {
        fmt.Println("Error executing request:", err)
        return
    }
}

Post

Create a body data to send in request

package main

import (
    "fmt"
    "github.com/tonnytg/webreq"
)

func main() {
    var headers = make(map[string]string)
    headers["Content-Type"] = "application/json"
    headers["Authorization"] = "Bearer your_token"
    
    request := webreq.NewRequest("POST")
    request.SetURL("https://api.example.com/data")
    request.SetData([]byte(`{"key":"value"}`)) // set data to POST
    request.SetHeaders(headers.Headers)
    request.SetTimeout(10)
    
    response, err := request.Execute()
    if err != nil {
        fmt.Println("Error executing request:", err)
        return
    }
    fmt.Println("Response:", string(response))
}

Advange Usage

Custom Headers

    headers := webreq.NewHeaders(nil)
    headers.Add("Content-Type", "application/json")
    if headers.Headers["Content-Type"] != "application/json" {
        t.Error("headers.Headers[Content-Type] is not application/json")
    }
    
    request := webreq.NewRequest("POST")
    request.SetURL("https://api.example.com/data")
    request.SetData([]byte(`{"key":"value"}`)) // set data to POST
    request.SetHeaders(headers.Headers)
    request.SetTimeout(10)
    
    response, err := request.Execute()
    if err != nil {
        fmt.Println("Error executing request:", err)
        return
    }
    fmt.Println("Response:", string(response))

Erro Handlin

response, err := webreq.Get("https://api.example.com/data")
if err != nil {
    switch err.(type) {
    case webreq.HTTPError:
        fmt.Println("HTTP error occurred:", err)
    default:
        fmt.Println("An error occurred:", err)
    }
    return
}
fmt.Println("Response:", response)

Contributing

• Fork the repository
• Create a new branch (git checkout -b feature-foo)
• Commit your changes (git commit -am 'Add some foo')
• Push to the branch (git push origin feature-foo)
• Create a new Pull Request

License

This project is licensed under the MIT License.

Contact

For any inquiries, please open an issue or reach out to the maintainer.

email: [email protected]