oapixconstgen

command module
v1.1.7 Latest Latest
Warning

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

Go to latest
Published: Nov 10, 2026 License: MIT Imports: 12 Imported by: 0

README

oapixconstgen

CI coverage version license

A Go tool that extracts typed constants from OpenAPI specification files and generates Go code.

Overview

When defining OpenAPI specs, you often need to reuse constant values (like pagination limits, timeouts, or configuration values) across multiple places using YAML anchors. oapixconstgen reads these constants from the x-constants extension and generates a Go file with properly typed constants, keeping your API spec and Go code in sync.

Installation

go install github.com/psyb0t/oapixconstgen@latest

Or add as a project tool (Go 1.24+):

go get -tool github.com/psyb0t/oapixconstgen@latest

This adds it to your go.mod under the tool directive, making it a versioned project dependency.

Usage

Given an OpenAPI spec with x-constants:

openapi: "3.0.0"

x-constants:
  int:
    defaultPageSize: &defaultPageSize 20
    maxPageSize: &maxPageSize 100
  string:
    defaultLocale: &defaultLocale "en-US"

paths:
  /items:
    get:
      parameters:
        - name: limit
          in: query
          schema:
            type: integer
            default: *defaultPageSize
            maximum: *maxPageSize

Run the generator:

oapixconstgen -spec=api.yaml -out=./internal/api -pkg=api

This generates internal/api/constants.gen.go:

// Code generated by oapixconstgen. DO NOT EDIT.

package api

const (
	DefaultLocale   string = "en-US"
	DefaultPageSize int    = 20
	MaxPageSize     int    = 100
)

The flags are -spec (required), -out (default .), -file (default constants.gen.go) and -pkg (default api). The type keys are the Go integer, float, string and bool types, and names like max_page_size become MaxPageSize. The documentation has the details, including go generate setup and what makes a run fail.

Documentation

The full docs live at psyb0t.github.io/oapixconstgen.

Page What's in it
Command line Every flag, exit codes, log lines, and go generate setup
The x-constants block The 14 type keys, how values and names are written, ordering, what fails
Development Make targets, coverage gate, CI and releases

Sponsor

Buy Me a Coffee

License

MIT

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

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