5 go-httpdoc - Golang package for generating API documentation from httptest

github.com godoc.org goreportcard.com posted by tomf 2600 days ago  

go-httpdoc is a Golang package to generate API documentation from httptest test cases.

It provides a simple http middleware which records http requests and responses from tests and generates documentation automatically in markdown format. See Sample Documentation. 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). If you write proper tests, it will generate usable documentation (namely, it forces you to write good tests).

Register to comment or vote on this story