swagger

package

v0.2.10 Latest Latest Go to latest Published: Jul 7, 2022 License: Apache-2.0 Imports: 18 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/pubgo/lava

Links

Open Source Insights

Documentation ¶

Constants ¶

This section is empty.

Variables ¶

View Source

var Cmd = &cli.Command{
	Name:        "swagger",
	Usage:       "start swagger web",
	Description: clix.ExampleFmt(`lava rest.http`),
	Action: func(ctx *cli.Context) error {
		var homeTmpl = template.Must(template.New("index").Parse(`
		<html>
		<head>
		<title>/swagger</title>
		</head>
		<body>
		{{range .}}
			<a href={{.}}>{{.}}</a><br/>
		{{end}}
		</body>
		</html>
		`))

		debug.Get("/", debug.WrapFunc(func(writer http.ResponseWriter, request *http.Request) {
			var names []string
			xerror.Panic(filepath.Walk("./docs", func(path string, info fs.FileInfo, err error) error {
				if strings.HasSuffix(path, ".swagger.json") {
					names = append(names, strings.TrimPrefix(path, "docs/"))
				}
				return nil
			}))
			xerror.Panic(homeTmpl.Execute(writer, names))
		}))

		debug.Get("/docs/*", debug.WrapFunc(func(writer http.ResponseWriter, request *http.Request) {
			writer.Header().Set("Content-Type", "application/json")
			var bytes, err = ioutil.ReadFile(strings.Trim(request.RequestURI, "/"))
			xerror.Panic(err)

			specDoc, err := loads.Analyzed(bytes, "")
			xerror.Panic(err)

			specDoc, err = specDoc.Expanded(&spec.ExpandOptions{
				SkipSchemas:         false,
				ContinueOnError:     true,
				AbsoluteCircularRef: true,
			})
			xerror.Panic(err)

			b, err := json.MarshalIndent(specDoc.Spec(), "", "  ")
			xerror.Panic(err)
			writer.Write(b)
		}))

		debug.Get("/swagger/*", debug.WrapFunc(func(writer http.ResponseWriter, request *http.Request) {
			var s ServeCmd
			var flavor = "swagger"
			if f := request.URL.Query().Get("flavor"); f != "" {
				flavor = f
			}

			basePath := s.BasePath
			if basePath == "" {
				basePath = "/"
			}

			handler := http.NotFoundHandler()
			if flavor == "redoc" {
				handler = middleware.Redoc(middleware.RedocOpts{
					Title:    request.URL.Path,
					BasePath: basePath,
					SpecURL:  fmt.Sprintf("/docs/%s", request.URL.Path),
					Path:     request.URL.Path,
				}, handler)
			} else if flavor == "swagger" {
				handler = middleware.SwaggerUI(middleware.SwaggerUIOpts{
					Title:    request.URL.Path,
					BasePath: basePath,
					SpecURL:  fmt.Sprintf("/docs/%s", request.URL.Path),
					Path:     request.URL.Path,
				}, handler)
			} else {
				handler = httpSwagger.Handler(
					httpSwagger.URL(fmt.Sprintf("%s.swagger.json", request.URL.Path)),
				)
			}
			handler.ServeHTTP(writer, request)
		}))

		syncx.GoDelay(func() {
			xerror.Panic(browser.OpenURL("http://localhost:8082"))
		})
		return nil
	},
}

Functions ¶

This section is empty.

Types ¶

type ServeCmd ¶

type ServeCmd struct {
	BasePath string `long:"base-path" description:"the base path to serve the spec and UI at"`
	Flavor   string `` /* 129-byte string literal not displayed */
	DocURL   string `long:"doc-url" description:"override the url which takes a url query param to render the doc ui"`
	NoOpen   bool   `long:"no-open" description:"when present won't open the the browser to show the url"`
	NoUI     bool   `long:"no-ui" description:"when present, only the swagger spec will be served"`
	Flatten  bool   `long:"flatten" description:"when present, flatten the swagger spec before serving it"`
	Port     int    `long:"port" short:"p" description:"the port to serve this site" env:"PORT"`
	Host     string `long:"host" description:"the interface to serve this site, defaults to 0.0.0.0" default:"0.0.0.0" env:"HOST"`
	Path     string `long:"path" description:"the uri path at which the docs will be served" default:"docs"`
}

ServeCmd to serve a swagger spec with docs ui

Source Files ¶

View all Source files

cmd.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL