redoc

package module
v0.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 7, 2021 License: MIT Imports: 7 Imported by: 0

README

Fiber Redoc

gofiber middleware for rendering Redoc. Compatible with Swagger notation (OpenAPI specification).

Usage

Use with fiber v2+, not tested with v1

func main() {
	app := fiber.New()
	app.Get("/docs/*", redoc.Handler)
}

Example

Please see example folder on this repository for simple setup.

Configuration

Config Default Value Description
To be added To be added To be added

Made with ❤ of swagger, fiber and react.js.

Documentation

Overview

Package redoc swagger

Index

Constants

This section is empty.

Variables

View Source
var Handler = New()

Handler registers "/index.html" and "/docs.json" endpoint as a form of fiber.Handler

Functions

func New

func New() fiber.Handler

New returns custom handler where it sends redoc HTML page with swagger docs.json if it's registered

Types

This section is empty.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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