go-redoc - GitLite

KO | EN

gitlite — search

#javascript #hacktoberfest #react #golang #rust #linux #macos #java #windows #cli #awesome-list #pytorch #mcp #openai

go-redoc

(★ 95)

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

파일 탐색기

최종 버전 다운로드 (.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

# 설치 가이드

1. 코드 내려받기

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

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd go-redoc

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Go

보통 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Go Go 언어 컴파일러 및 도구 모음입니다.

cd _examples/echo

이 프로젝트의 관련 파일이 하위 폴더 안에 있어서, 먼저 그 폴더로 이동합니다.

go build ./...

Go 프로그램을 컴파일해 실행 파일을 만듭니다.

go run .

따로 빌드하지 않고 바로 Go 프로그램을 실행합니다.

✅ 빌드가 에러 없이 끝나면 성공입니다. go run . 을 썼다면 터미널 출력을 확인하세요.

3. Make

보통

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
Make Linux/macOS는 보통 기본 설치되어 있습니다. Windows는 별도 설치(예: MSYS2, WSL)가 필요합니다.

make

생성된 빌드 설정을 바탕으로 실제 컴파일을 진행해 실행 파일을 만듭니다.

✅ 에러 없이 끝나면 성공입니다. 생성된 실행 파일을 직접 실행해보세요.

// 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)