_example

README

httpdoc example

This directory contains some examples of httpdoc.

• handler_simple_test.go generates doc/simple.md
• handler_validate_test.go generates doc/validate.md
• handler_proto_test.go generates doc/protobuf.md

To generate documentation, run the following command:

$ env HTTPDOC=1 go test -v

One example uses protocol buffer, message definition is in ../proto directory. To generate code from that, run the following command:

# Install protoc-gen-go if you don't have it
$ go get -u github.com/golang/protobuf/protoc-gen-go

$ protoc -I=./../proto --gofast_out=./ ../proto/message.proto

Documentation

Overview

Package httpdoc is a generated protocol buffer package.

It is generated from these files:

message.proto

It has these top-level messages:

UserProtoRequest
UserProtoResponse