matryer/silk is a Go project with 939 stars in the Developer Tools space. Markdown based document-driven RESTful API testing.
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
Adding parameters to the path (like GET /path?q=something) can be tricky, especially when you consider escaping etc. To address this, Silk supports parameters like lists:
* ?param=value
The parameters will be correctly added to the URL path before the request is made.
Cookies
Setting cookies on a request can be done using the HTTP header pattern:
* Cookie: "key=value"
See asserting cookies.
Assertions
Following the --- separator, you can specify assertions about the response. At a minimum, it is recommended that you assert the status code to ensure the request succeeded:
* Status: 200
You may also specify response headers in the same format as request headers:
If any of the headers do not match, the test will fail.
Capturing data
Silk allows you to capture values at the point of asserting them and reuse them in future requests and assertions. To capture a value, include a comment on the line that mentions a {placeholder}:
* Data.UserID: /.*/ // The user's unique {id}.
The value from UserID (e.g. 123) will be stored in a variable called id, and you can refer to it later:
## GET /users/{id}
The above would be a request to GET /users/123.
Captured values are only available when assertions are successful
Environment variables
You can access environment variables inside Silk tests using the {$NAME} format, where NAME is the environment name.
Asserting cookies
To assert that a cookie is present in a response, make a regex assertion against the Set-Cookie HTTP header:
* Set-Cookie: /key=value/
All cookie strings are present in a single Set-Cookie seperated by a pipe character.
Validating data
You can optionally include a verbatim body using code blocks surrounded by three back tics. If the response body does not exactly match, the test will fail:
```
Hello world!
```
You can flag expected response bodies as json directly after the three back tics.
This will assert that the actual response contains the same value for each expected key (recursively)
allowing for differences in whitespace and ordering as well as being lenient towards additional (unexpected) keys in the response.
You can use the flag json(strict) to enforce that no additional fields may be present while still allowing for differences in whitespace and key order.
You may also make any number of regex assertions against the body using the Body object:
* Body: /Hello world/
* Body: /This should be found too/
* Body: /and this/
Alternatively, you can specify a list (using *) of data fields to assert accessible via the Data object:
NOTE: Currenly this feature is only supported for JSON APIs.
Regex
Values may be regex, if they begin and end with a forward slash: /. The assertion will pass if the value (after being turned into a string) matches the regex.
The silk command runs tests against an HTTP endpoint.
Usage:
silk -silk.url="{endpoint}" {testfiles...}
{endpoint} the endpoint URL (e.g. http://localhost:8080)
{testfiles} list of test files (e.g. ./testfiles/one.silk.md ./testfiles/two.silk.md)
Notes:
Omit trailing slash from endpoint
{testfiles} can include a pattern (e.g. /path/*.silk.md) as this is expended by most terminals to a list of matching files
Golang
Silk is written in Go and integrates seamlessly into existing testing tools and frameworks. Import the runner package and use RunGlob to match many test files:
package project_test
import (
"testing"
"github.com/matryer/silk/runner"
)
func TestAPIEndpoint(t *testing.T) {
// start a server
s := httptest.NewServer(yourHandler)
defer s.Close()
// run all test files
runner.New(t, s.URL).RunGlob(filepath.Glob("../testfiles/failure/*.silk.md"))
}
See the documentation for the silk/runner package
Credit
Special thanks to @dahernan for his contributions and criticisms of Silk
Yes — matryer/silk ships under the GPL-2.0 license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/matryer/silk.
What else is in the Developer Tools space?
matryer/silk is tracked by TopGit under the Developer Tools category, alongside 2 GitHub-tagged topics. Trending and Topics pages list peer repositories of comparable stars and language.
What is matryer/silk?
matryer/silk (matryer/silk) is a Go project on GitHub. From the project's own README: Markdown based document-driven RESTful API testing.
What license does matryer/silk use?
matryer/silk is released under the GPL-2.0 license. Always verify the LICENSE file directly on GitHub for the authoritative terms — license strings can be edited out of sync with a project's actual stance.
Where can I see matryer/silk in action?
The project maintains a homepage at http://silktest.org/. The README tab on this page also usually contains screenshots and a quickstart.
Where do I read more about matryer/silk?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/matryer/silk is the definitive source.
Why is matryer/silk categorized under Developer Tools?
TopGit places matryer/silk in the Developer Tools category based on its GitHub topics and description (tagged: "assertions", "testing"). Categories are assigned from real repository metadata, not editorial guesswork.
Read full README in the tab above.
Still deciding about silk?
One click hands the question to an AI along with this page — see what it says about silk.