apitest

package

v1.0.1 Latest Latest Go to latest Published: Oct 28, 2026 License: MIT Imports: 14 Imported by: 0

Details

Package apitest drives the API in handler tests the way a same-origin browser would.

This section is empty.

This section is empty.

func Decode[T any](t *testing.T, rec *httptest.ResponseRecorder) T

Decode unmarshals the response body into T.

func ErrorOf(t *testing.T, rec *httptest.ResponseRecorder) web.APIError

ErrorOf decodes the JSON error envelope.

func NewEcho() *echo.Echo

NewEcho returns an Echo set up like production: API errors are JSON and other errors get the HTML error page.

type Client struct {
	// contains filtered or unexported fields
}

Client sends requests to an Echo instance, optionally with a session cookie.

func New(e *echo.Echo) *Client

func (c *Client) As(cookie *http.Cookie) *Client

As returns a client that sends cookie with every request.

func (c *Client) Do(t *testing.T, req *http.Request) *httptest.ResponseRecorder

Do serves req as a same-origin browser request.

func (c *Client) Get(t *testing.T, path string) *httptest.ResponseRecorder

func (c *Client) JSON(t *testing.T, method, path string, body any) *httptest.ResponseRecorder

JSON sends body encoded as JSON; a nil body sends no body.

func (c *Client) Multipart(t *testing.T, method, path string, fields map[string]string, files ...FilePart) *httptest.ResponseRecorder

Multipart sends fields and files as multipart/form-data.

type FilePart struct {
	Field, Name, ContentType, Body string
}

FilePart is one file in a multipart request.