openapi

module
v0.0.0-...-23ea13f Latest Latest
Warning

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

Go to latest
Published: May 9, 2026 License: MIT

README

Go-Bricks OpenAPI Generator

Static analysis-based OpenAPI 3.0.1 specification generator for go-bricks services.

Quick Start

# Install the tool
go install ./tools/openapi/cmd/go-bricks-openapi

# Generate OpenAPI spec
go-bricks-openapi generate -project . -output docs/openapi.yaml

# Check tool health and compatibility
go-bricks-openapi doctor -project .

Commands

  • generate - Generate OpenAPI specification from go-bricks service
  • doctor - Check compatibility and environment health
  • version - Show tool version

Requirements

  • Go 1.25+
  • go-bricks v0.13.0+

Post Release

GOPROXY=https://proxy.golang.org GO111MODULE=on go get github.com/gaborage/go-bricks@vX.Y.Z

Directories

Path Synopsis
cmd
internal

Jump to

Keyboard shortcuts

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