Body allows you to add a matcher for the body of the request.

var getUserMock = apitest.NewMock().
    Post("http://example.com/user/12345").
    Body(`{"username": "John"}`).
    RespondWith().
    Status(http.StatusOK).
    End()

If you are working with a URL encoded form body, you can use FormData to match a key and value. Regular expressions are also allowed as values.

FormData("name", "Simon").
FormData("name", "Jo([a-z]+)n").

You can also require a form body key to be present (FormDataPresent) or not present (FormDataNotPresent)

FormDataPresent("name").
FormDataNotPresent("pets").

The JSONPath extension provides a custom Matcher to support matching on the request body. This is useful for partially matching on the body.

apitest.NewMock().
    Post("/user-external").
    AddMatcher(mocks.Equal("$.name", "jan")).
    RespondWith().

package matchers

import (
	"bytes"
	jsonpath "github.com/steinfletcher/apitest-jsonpath/mocks"
	"io/ioutil"
	"net/http"
	"testing"

	"github.com/steinfletcher/apitest"
)

func TestMocks(t *testing.T) {
	createUserMock := apitest.NewMock().
		Post("/user-external").
		AddMatcher(jsonpath.Equal("$.name", "jan")).
		RespondWith().
		Status(http.StatusCreated).
		End()

	apitest.New().
		Mocks(createUserMock).
		Handler(myHandler()).
		Post("/user").
		JSON(map[string]string{"name": "jan"}).
		Expect(t).
		Status(http.StatusCreated).
		End()
}

func myHandler() *http.ServeMux {
	handler := http.NewServeMux()
	handler.HandleFunc("/user", func(w http.ResponseWriter, r *http.Request) {
		reqBody, err := ioutil.ReadAll(r.Body)
		if err != nil {
			panic(err)
		}

		_, err = http.DefaultClient.Post("http://localhost:8080/user-external", "application/json", bytes.NewReader(reqBody))
		if err != nil {
			panic(err)
		}

		w.WriteHeader(http.StatusCreated)
	})
	return handler
}

Cookie allows you to add a matcher for a cookie name and value.

var getUserMock = apitest.NewMock().
    Get("http://example.com/user/12345").
    Cookie("sessionid", "1321").
    RespondWith().
    Body(`{"name": "jon"}`).
    Status(http.StatusOK).
    End()

You can also require a cookie name to be present (CookiePresent) or not present (CookieNotPresent)

var getUserMock = apitest.NewMock().
    Get("http://example.com/user/12345").
    CookiePresent("trackingid").
    CookieNotPresent("analytics").
    RespondWith().
    Body(`{"name": "jon"}`).
    Status(http.StatusOK).
    End()

You can write you own custom matcher using AddMatcher. A matcher function is defined as func(*http.Request, *MockRequest) error

var getUserMock = apitest.NewMock().
    Post("http://example.com/user/12345").
    AddMatcher(func(req *http.Request, mockReq *MockRequest) error {
    	if req.Method == http.MethodPost {
    		return nil
    	}
    	return errors.New("invalid http method")
    }).
    RespondWith().
    Status(http.StatusOK).
    End()

Header allows you to add a matcher for the header key and value. Regular expressions are also allowed as values

var getUserMock = apitest.NewMock().
    Get("http://example.com/user/12345").
    Header("foo", "bar").
    Header("token", "b([a-z]+)z").
    Headers(map[string]string{"name": "John"})
    RespondWith().
    Body(`{"name": "jon"}`).
    Status(http.StatusOK).
    End()

You can also require a header to be present (HeaderPresent) or not present (HeaderNotPresent).

var getUserMock = apitest.NewMock().
    Get("http://example.com/user/12345").
    HeaderPresent("authtoken").
    HeaderNotPresent("requestid").
    RespondWith().
    Body(`{"name": "jon"}`).
    Status(http.StatusOK).
    End()

Query allows you to add a matcher for the a url query parameter key and value. Regular expressions are also allowed as values.

var getUserMock = apitest.NewMock().
    Get("http://example.com/user/12345").
    Query("page", "1").
    Query("name", "Jo([a-z]+)n").
    QueryParams(map[string]string{"orderBy": "ASC"}).
    RespondWith().
    Body(`{"name": "jon"}`).
    Status(http.StatusOK).
    End()

You can also require a query parameter to be present (QueryPresent) or not present (QueryNotPresent)

var getUserMock = apitest.NewMock().
    Get("http://example.com/user/12345").
    QueryPresent("page").
    QueryNotPresent("name").
    RespondWith().
    Body(`{"name": "jon"}`).
    Status(http.StatusOK).
    End()