github.com/cloudwego/dynamicgo@v0.2.6-0.20240519101509-707f41b6b834/http/README.md

<!-- Code generated by gomarkdoc. DO NOT EDIT -->

# http

```go
import "github.com/cloudwego/dynamicgo/http"
```

## Index

- [Constants](<#constants>)
- [Variables](<#variables>)
- [func AnnoToMethod(annoKey string) string](<#func-annotomethod>)
- [type Endpoint](<#type-endpoint>)
- [type HTTPRequest](<#type-httprequest>)
  - [func NewHTTPRequest() *HTTPRequest](<#func-newhttprequest>)
  - [func NewHTTPRequestFromStdReq(req *http.Request, params ...Param) (ret *HTTPRequest, err error)](<#func-newhttprequestfromstdreq>)
  - [func NewHTTPRequestFromUrl(method, url string, body io.Reader, params ...Param) (*HTTPRequest, error)](<#func-newhttprequestfromurl>)
  - [func (self HTTPRequest) Body() []byte](<#func-httprequest-body>)
  - [func (self HTTPRequest) Cookie(key string) string](<#func-httprequest-cookie>)
  - [func (self HTTPRequest) Header(key string) string](<#func-httprequest-header>)
  - [func (self HTTPRequest) Host() string](<#func-httprequest-host>)
  - [func (self *HTTPRequest) MapBody(key string) string](<#func-httprequest-mapbody>)
  - [func (self HTTPRequest) Method() string](<#func-httprequest-method>)
  - [func (self HTTPRequest) Param(key string) string](<#func-httprequest-param>)
  - [func (self HTTPRequest) Path() string](<#func-httprequest-path>)
  - [func (self HTTPRequest) PostForm(key string) string](<#func-httprequest-postform>)
  - [func (self HTTPRequest) Query(key string) string](<#func-httprequest-query>)
  - [func (self HTTPRequest) Uri() string](<#func-httprequest-uri>)
- [type HTTPResponse](<#type-httpresponse>)
  - [func NewHTTPResponse() *HTTPResponse](<#func-newhttpresponse>)
  - [func (self HTTPResponse) SetCookie(key string, val string) error](<#func-httpresponse-setcookie>)
  - [func (self HTTPResponse) SetHeader(key string, val string) error](<#func-httpresponse-setheader>)
  - [func (self HTTPResponse) SetRawBody(body []byte) error](<#func-httpresponse-setrawbody>)
  - [func (self HTTPResponse) SetStatusCode(code int) error](<#func-httpresponse-setstatuscode>)
- [type Param](<#type-param>)
- [type Params](<#type-params>)
  - [func (ps *Params) ByName(name string) string](<#func-params-byname>)
  - [func (ps *Params) Recycle()](<#func-params-recycle>)
  - [func (ps *Params) Set(name string, val string) bool](<#func-params-set>)
- [type RequestGetter](<#type-requestgetter>)
- [type ResponseSetter](<#type-responsesetter>)


## Constants

```go
const (
    // HeaderContentType is the key of Content-Type header
    HeaderContentType = "Content-Type"
    // HeaderSetCookie is the key of Set-Cookie header
    HeaderSetCookie = "Set-Cookie"
)
```

## Variables

```go
var (
    // DefaultJsonPairSize is the default size of json.Pair slice.
    DefaultJsonPairSize = 16
)
```

## func AnnoToMethod

```go
func AnnoToMethod(annoKey string) string
```

AnnoToMethod maps annotation to corresponding http method

## type Endpoint

Endpoint a http endpoint.

```go
type Endpoint struct {
    Method, Path string
}
```

## type HTTPRequest

Request is a implementation of RequestGetter. It wraps http.Request.

```go
type HTTPRequest struct {
    *http.Request

    Params  Params
    BodyMap interface{}
    // contains filtered or unexported fields
}
```

### func NewHTTPRequest

```go
func NewHTTPRequest() *HTTPRequest
```

NewHTTPRequest creates a new HTTPRequest.

### func NewHTTPRequestFromStdReq

```go
func NewHTTPRequestFromStdReq(req *http.Request, params ...Param) (ret *HTTPRequest, err error)
```

NewHTTPRequestFromStdReq creates a new HTTPRequest from http.Request. It will check the content\-type of the request and parse the body if the type one of following: \- application/json \- application/x\-www\-form\-urlencoded

### func NewHTTPRequestFromUrl

```go
func NewHTTPRequestFromUrl(method, url string, body io.Reader, params ...Param) (*HTTPRequest, error)
```

NewHTTPRequestFromUrl creates a new HTTPRequest from url, body and url\-path param.

### func \(HTTPRequest\) Body

```go
func (self HTTPRequest) Body() []byte
```

Body implements RequestGetter.Body.

### func \(HTTPRequest\) Cookie

```go
func (self HTTPRequest) Cookie(key string) string
```

Cookie implements RequestGetter.Cookie.

### func \(HTTPRequest\) Header

```go
func (self HTTPRequest) Header(key string) string
```

Header implements RequestGetter.Header.

### func \(HTTPRequest\) Host

```go
func (self HTTPRequest) Host() string
```

Host implements RequestGetter.Host.

### func \(\*HTTPRequest\) MapBody

```go
func (self *HTTPRequest) MapBody(key string) string
```

MapBody implements RequestGetter.MapBody.

### func \(HTTPRequest\) Method

```go
func (self HTTPRequest) Method() string
```

Method implements RequestGetter.Method.

### func \(HTTPRequest\) Param

```go
func (self HTTPRequest) Param(key string) string
```

Param implements RequestGetter.Param.

### func \(HTTPRequest\) Path

```go
func (self HTTPRequest) Path() string
```

Path implements RequestGetter.Path.

### func \(HTTPRequest\) PostForm

```go
func (self HTTPRequest) PostForm(key string) string
```

PostForm implements RequestGetter.PostForm.

### func \(HTTPRequest\) Query

```go
func (self HTTPRequest) Query(key string) string
```

Query implements RequestGetter.Query.

### func \(HTTPRequest\) Uri

```go
func (self HTTPRequest) Uri() string
```

Uri implements RequestGetter.Uri.

## type HTTPResponse

HTTPResponse is an implementation of ResponseSetter

```go
type HTTPResponse struct {
    *http.Response
}
```

### func NewHTTPResponse

```go
func NewHTTPResponse() *HTTPResponse
```

NewHTTPResponse creates a new HTTPResponse

### func \(HTTPResponse\) SetCookie

```go
func (self HTTPResponse) SetCookie(key string, val string) error
```

SetCookie implements ResponseSetter.SetCookie

### func \(HTTPResponse\) SetHeader

```go
func (self HTTPResponse) SetHeader(key string, val string) error
```

SetHeader implements ResponseSetter.SetHeader

### func \(HTTPResponse\) SetRawBody

```go
func (self HTTPResponse) SetRawBody(body []byte) error
```

### func \(HTTPResponse\) SetStatusCode

```go
func (self HTTPResponse) SetStatusCode(code int) error
```

SetStatusCode implements ResponseSetter.SetStatusCode

## type Param

### Param in url path

e.g. /user/:id \+ /user/123 =\> Param\{Key: "id", Value: "123"\}

```go
type Param struct {
    Key   string
    Value string
}
```

## type Params

Http url\-path params

```go
type Params struct {
    // contains filtered or unexported fields
}
```

### func \(\*Params\) ByName

```go
func (ps *Params) ByName(name string) string
```

ByName search Param by given name

### func \(\*Params\) Recycle

```go
func (ps *Params) Recycle()
```

Recycle the Params

### func \(\*Params\) Set

```go
func (ps *Params) Set(name string, val string) bool
```

Set set Param by given name and value, return true if Param exists

## type RequestGetter

RequestGetter is a interface for getting request parameters

```go
type RequestGetter interface {
    // Method returns the http method.
    Method() string
    // Host returns the host.
    Host() string
    // Uri returns entire uri.
    Uri() string
    // Header returns the value of the header with the given key.
    Header(string) string
    // Cookie returns the value of the cookie with the given key.
    Cookie(string) string
    // Query returns the value of the query with the given key.
    Query(string) string
    // Param returns the value of the url-path param with the given key.
    Param(string) string
    // PostForm returns the value of the post-form body with the given key.
    PostForm(string) string
    // MapBody returns the value of body with the given key.
    MapBody(string) string
    // Body returns the raw body in bytes.
    Body() []byte
}
```

## type ResponseSetter

ResponseSetter is a interface for setting response parameters

```go
type ResponseSetter interface {
    // SetStatusCode sets the status code of the response
    SetStatusCode(int) error
    // SetHeader sets the header of the response
    SetHeader(string, string) error
    // SetCookie sets the cookie of the response
    SetCookie(string, string) error
    // SetRawBody sets the raw body of the response
    SetRawBody([]byte) error
}
```



Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)