forked from mercari/go-httpdoc
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdoc.go
More file actions
9 lines (9 loc) · 638 Bytes
/
doc.go
File metadata and controls
9 lines (9 loc) · 638 Bytes
1
2
3
4
5
6
7
8
9
// Package httpdoc is a Golang package for generating API documentation from httptest test cases.
//
// It provides a simple http middleware for recording various http requst & response values you use in your tests
// and automatically arranges and generates them as usable documentation in markdown format. It also provides a way
// to validate values are equal to what you expect with annotation (e.g., you can add a description for headers,
// params or response fields).
//
// See example document output, https://github.com/mercari/go-httpdoc/blob/master/_example/doc/validate.md
package httpdoc // import "go.mercari.io/go-httpdoc"