Add JWT docs

steinfletcher · Apr 4, 2020 · 76fce30 · 76fce30
1 parent 49aadad
commit 76fce30
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -115,3 +115,23 @@ apitest.New().
 	Assert(Matches(`$.a`, `^[abc]{1,3}$`)).
 	End()
 ```
+
+### JWT matchers
+
+`JWTHeaderEqual` and `JWTPayloadEqual` can be used to assert on the contents of the JWT in the response (it does not verify a JWT).
+
+```go
+func TestX(t *testing.T) {
+	apitest.New().
+		HandlerFunc(myHandler).
+		Post("/login").
+		Expect(t).
+		Assert(jsonpath.JWTPayloadEqual(fromAuthHeader, `$.sub`, "1234567890")).
+		Assert(jsonpath.JWTHeaderEqual(fromAuthHeader, `$.alg`, "HS256")).
+		End()
+}
+
+func fromAuthHeader(res *http.Response) (string, error) {
+	return res.Header.Get("Authorization"), nil
+}
+```