Getting started

Install

As a library, to call from your own program:

go get github.com/go-openapi/codescan

codescan exposes a deliberately small surface: a single Run function and an Options struct.

func Run(opts *Options) (*spec.Swagger, error)

Or as a command, to run in a build or a pipeline:

go install github.com/go-openapi/codescan/cmd/genspec@latest

Or as a terminal front-end, to watch a spec take shape as you annotate:

go install github.com/go-openapi/codescan/cmd/genspec-tui@latest

If you just want to experiment, learn or reproduce an issue you’re currently having, the easiest way is to try our Playground in your browser.

Ways to use codescan

• Usage as a library

  Import codescan, annotate a package.

  Produce a Swagger 2.0 specification from your Go program.

• Usage as a headless CLI

  Point genspec at annotated Go source and get a Swagger 2.0 document — on standard output, in a file, checked against the schema, or as a machine-readable envelope from a sandbox with no Go toolchain in it.
• Usage as a terminal UI

  Drive codescan interactively: browse an annotated source tree, watch the spec it produces.

  It re-renders on every save, and follow any node back to the code that made it.

All three drive the same scanner over the same annotations, and every knob is spelled the same way in each, so the terminal UI shows exactly the document your build will produce.

See Setting an option.