swaggerui

README

swaggerui

Embedded, self-hosted Swagger Ui for go servers

This module provides swaggerui.Handler, which you can use to serve an embedded copy of Swagger UI as well as an embedded specification for your API.

Example usage

package main

import (
	_ "embed"
	"log"
	"net/http"

	"github.com/flowchartsman/swaggerui"
)

//go:embed swagger.json
var spec []byte

func main() {
	log.SetFlags(0)
	http.Handle("/swagger/", http.StripPrefix("/swagger", swaggerui.Handler(spec)))
	log.Println("serving on :8080")
	log.Fatal(http.ListenAndServe(":8080", nil))
}

Documentation

Index

• Variables
• func ByteHandler(b []byte) http.HandlerFunc
• func Handler(spec []byte) http.Handler

Variables

var Swagfs embed.FS

Functions

func ByteHandler

func ByteHandler(b []byte) http.HandlerFunc

func Handler

func Handler(spec []byte) http.Handler

Handler returns a handler that will serve a self-hosted Swagger UI with your spec embedded