Getting started

Install

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)

Ways to use codescan

• Usage as a library

  Import codescan, annotate a package, and produce a Swagger 2.0 specification from your Go program.

Today, codescan is used as a Go library (below). Additional usage modes will appear here as siblings as the toolkit grows.