go-redoc - GitLite

KO | EN

gitlite — search

#python #react #ai #machine-learning #docker #macos #nodejs #awesome #cli #kubernetes #awesome-list #pytorch #ios #mcp

go-redoc

(★ 95)

go-redoc is an embedded OpenAPI/Swagger documentation ui for Go using ReDoc

File Explorer

Download Latest Version (.zip)

- - ci.yaml
- - go.mod
  - go.sum
  - main.go
  - openapi.json
- - go.mod
  - go.sum
  - main.go
  - openapi.json
- - go.mod
  - go.sum
  - main.go
  - Makefile
- - go.mod
  - go.sum
  - main.go
  - openapi.json
- - go.mod
  - go.sum
  - main.go
  - openapi.json
- - go.mod
  - go.sum
  - main.go
  - openapi.json
- - go.mod
  - go.sum
  - main.go
  - openapi.json
- index.html
- redoc.standalone.js
- echo.go
- go.mod
- go.sum
- fiber.go
- go.mod
- go.sum
- gin.go
- go.mod
- go.sum
- go.mod
- go.sum
- iris.go
- spec.json
.gitignore
go.mod
go.sum
LICENSE
Makefile
README.md
redoc.go
redoc_test.go

# Installation Guide

1. Get the code

git clone https://github.com/mvrilo/go-redoc

Downloads the entire project code from GitHub to your computer.

cd go-redoc

Moves into the project folder you just downloaded.

2. Go

Medium Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Go The Go compiler and toolchain.

cd _examples/echo

This project's files live in a subfolder, so move into it first.

go build ./...

Compiles the Go program into an executable.

go run .

Runs the Go program directly without a separate build step.

✅ If the build finishes without errors, it worked. If you used go run ., check the terminal output.

3. Make

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).

make

Compiles the code based on the generated build configuration to produce an executable.

✅ If it finishes without errors, it worked. Try running the generated executable directly.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# go-redoc

[![GoDoc](https://godoc.org/github.com/mvrilo/go-redoc?status.svg)](https://godoc.org/github.com/mvrilo/go-redoc)
[![Go Report Card](https://goreportcard.com/badge/github.com/mvrilo/go-redoc?_=1)](https://goreportcard.com/report/github.com/mvrilo/go-redoc?_=1)

`go-redoc` is an embedded OpenAPI documentation ui for Go using [ReDoc](https://github.com/ReDocly/redoc) and Go's [1.16+'s embed package](https://golang.org/pkg/embed/), with middleware implementations for: `net/http`, `gin`, `fiber`, `echo`, and `iris`.

The template is based on the ReDoc's [bundle template](https://github.com/ReDocly/redoc/blob/master/cli/template.hbs) with the script already placed in the html instead of depending on a CDN.

This package does not generate openapi spec file. Check [this example](_examples/gen) for using code generation with swag.

## Usage

```go
import "github.com/mvrilo/go-redoc"

...

doc := redoc.Redoc{
    Title:       "Example API",
    Description: "Example API Description",
    SpecFile:    "./openapi.json", // "./openapi.yaml"
    SpecPath:    "/openapi.json",  // "/openapi.yaml"
    DocsPath:    "/docs",
}
```

- `net/http`

```go
import (
	"net/http"
	"github.com/mvrilo/go-redoc"
)

...

http.ListenAndServe(address, doc.Handler())
```

- `gin`

```go
import (
	"github.com/gin-gonic/gin"
	"github.com/mvrilo/go-redoc"
	ginredoc "github.com/mvrilo/go-redoc/gin"
)

...

r := gin.New()
r.Use(ginredoc.New(doc))
```

- `echo`

```go
import (
	"github.com/labstack/echo/v4"
	"github.com/mvrilo/go-redoc"
	echoredoc "github.com/mvrilo/go-redoc/echo"
)

...

r := echo.New()
r.Use(echoredoc.New(doc))
```

- `fiber`

```go
import (
	"github.com/gofiber/fiber/v2"
	"github.com/mvrilo/go-redoc"
	fiberredoc "github.com/mvrilo/go-redoc/fiber"
)

...

r := fiber.New()
r.Use(fiberredoc.New(doc))
```

- `iris`

```go
import (
	"github.com/kataras/iris/v12"
	"github.com/mvrilo/go-redoc"
	irisdoc "github.com/mvrilo/go-redoc/iris"
)

...

app := iris.New()
app.Use(irisdoc.New(doc))
```

See [examples](/_examples)