Skip to content
Snapshot of the v0.5 release. Fixes and additions since then are not in it. Current documentation →
Reference

Reference

Exhaustive lookup material: what the tags mean, what the generator emits, what the CLI accepts, and what the runtime exposes.

Godoc

Signature-level API reference — every exported type, function and method, across all packages — is published automatically on pkg.go.dev:

The pages here cover what godoc cannot: how the pieces fit together, which struct tag drives which behaviour, and why a given default is what it is. Use pkg.go.dev to look up a signature, and these pages to understand it.

Per-package entry points:

PackageReference
goninjagodoc · Runtime API
goninja/openapigodoc
goninja/docsuigodoc
goninja/idgodoc
goninja/goninjatestgodoc