README
¶
pontoon
This is a library (and a CLI tool) that generates OpenAPI 3.1 documentation for Go services.
It generates the OpenAPI spec from Go structs and their Go comments, annotated with ggicci/httpin tags.
docgen (CLI) extracts the documentation from the Go code at a compile time; and in the runtime, docmerge merges it with the OpenAPI spec generated by httpinmeditate.
The runtime part of this library is meant to be integrated with the router library of your choice, or it can be used with the raw http server.
See the raw HTTP server usage example at /examples/petstore.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
pontoon-gendoc
command
|
|
|
pontoongen
command
|
|
|
Package docgen provides tools for extracting and storing documentation from Go source code.
|
Package docgen provides tools for extracting and storing documentation from Go source code. |
|
docregistry
Package docregistry provides a registry for documentation entities extracted from the comments.
|
Package docregistry provides a registry for documentation entities extracted from the comments. |
|
examples
|
|
|
petstore/cmd/server
command
|
|
|
openapi
|
|
Click to show internal directories.
Click to hide internal directories.