How do I integrate oaswrap/spec with the Echo framework?

Use the echoopenapi adapter package from the adapter ecosystem. It automatically generates OpenAPI specs from your Echo routes and sets up documentation endpoints like /docs with minimal configuration.

oaswrap/spec vs Huma: which is better for a new Go API?

Choose Huma if you want a complete HTTP framework with built-in validation and routing. Oaswrap/spec is better for documenting existing APIs or when you need framework flexibility without being tied to a specific ecosystem.

Does oaswrap/spec support API key authentication in OpenAPI?

Yes, you can define API key security schemes using option.SecurityAPIKey() with configurable header or query parameters, as demonstrated in the security schemes configuration section.

How to generate a static OpenAPI JSON file instead of YAML?

The WriteSchemaTo method outputs YAML by default, but you can customize the output format by using the underlying openapi-go library to marshal the spec to JSON, though this requires extra code as shown in advanced examples.

Is oaswrap/spec production ready for large-scale APIs?

Due to its beta status, it's best for teams comfortable with evolving tools. Core functionality is solid, but the FAQ recommends thorough testing before deployment in critical environments.

Can I use oaswrap/spec without a web framework for documentation only?

Yes, the standalone version allows programmatic spec building for existing APIs without framework integration, ideal for CI/CD pipelines or custom documentation tools as shown in the static generation quick start.

oaswrap/fiberopenapi

MITGov0.5.1

A lightweight, framework-agnostic OpenAPI 3.x specification builder for Go, offering programmatic control and zero dependencies.

Visit Website

What is oaswrap/fiberopenapi?

oaswrap/spec is a lightweight, framework-agnostic OpenAPI 3.x specification builder for Go. It allows developers to programmatically create API documentation using pure Go code, providing type safety and avoiding vendor lock-in. The library supports both static spec generation for CI/CD pipelines and integration with popular Go web frameworks via adapters.

Target Audience

Go developers building REST APIs who need programmatic, type-safe OpenAPI documentation generation, especially those working with existing codebases or multiple web frameworks.

Value Proposition

Developers choose oaswrap/spec for its framework-agnostic design, zero dependencies, and code-first approach that offers better IDE support and type safety compared to annotation-based alternatives. It provides flexibility for both static generation and live integration.

Overview

⚡A lightweight, framework-agnostic OpenAPI 3.x specification builder for Go.

Use Cases

Best For

Generating OpenAPI specs at build time in CI/CD pipelines

Related Projects

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub

GitHub

109 stars5 forks0 contributors

Documenting existing Go APIs without refactoring to a specific framework

Building custom API documentation tools with programmatic control

Teams using multiple Go web frameworks who want a unified documentation approach

Projects requiring type-safe OpenAPI specification generation

Developers preferring code-first documentation over annotation-based systems

Not Ideal For

Teams building new APIs from scratch who want an all-in-one framework with automatic request validation and routing
Projects that prefer annotation-based OpenAPI generation over writing additional Go code for documentation
Large enterprises requiring stable, production-ready tools with long-term support and minimal breaking changes
Simple APIs where a lightweight, annotation-based tool like swaggo would suffice with less boilerplate

Pros & Cons

Pros

Framework Agnostic Flexibility

Works with any Go web framework or as a standalone tool, allowing integration into diverse codebases without vendor lock-in, as highlighted in the README's adapter ecosystem for Chi, Echo, Gin, and more.

Type-Safe Code-First Approach

Uses pure Go code with struct tags for full type safety, providing better IDE support and compile-time checks compared to annotation-based alternatives like swaggo.

Extensive Adapter Ecosystem

Offers dedicated adapters for popular frameworks that enable automatic spec generation and built-in documentation UI at endpoints like /docs, reducing setup time for integrated use.

CI/CD Pipeline Ready

Supports static spec generation at build time with methods like WriteSchemaTo, making it ideal for documentation pipelines and version-controlled API specs, as shown in the static generation example.

Cons

Beta Software Stability

The library is in active development and considered beta, requiring thorough testing before production use, with potential for breaking changes as admitted in the FAQ.

Lacks Integrated Validation

Focuses solely on documentation generation without built-in request/response validation, unlike frameworks like Huma, which means additional middleware is needed for full API lifecycle management.

Code-Intensive Documentation

Requires writing explicit Go code for spec definitions, which can be more verbose and time-consuming than annotation-based systems for straightforward APIs, adding boilerplate.

Frequently Asked Questions

Home

Fiber

souin

An HTTP cache system, RFC compliant, compatible with @tyktechnologies, @traefik, @caddyserver, @go-chi, @bnkamalesh, @beego, @devfeel, @labstack, @gofiber, @go-goyave, @go-kratos, @gin-gonic, @roadrunner-server, @zalando, @zeromicro, @nginx and @apache

Stars972

Forks79

Last commit3 days ago

go-agent

New Relic Go Agent

Stars833

Forks315

Last commit3 days ago

elastic/apmfiber

The Elastic APM Agent for Go is the official package that enables developers to monitor and trace the execution of operations within Go applications. It collects performance metrics, errors, and distributed traces, sending them to the Elastic APM Server for visualization and analysis in Kibana. This helps identify performance bottlenecks, errors, and latency issues in production environments. ## Key Features - **Application Performance Monitoring** — Traces requests, database queries, and external HTTP calls to provide detailed performance insights. - **Error Tracking** — Automatically captures and reports application errors and exceptions with full stack traces. - **Distributed Tracing** — Supports end-to-end tracing across microservices and distributed systems. - **Framework Integration** — Works with popular Go web frameworks and libraries like Fiber, Gin, and Echo. - **Low Overhead** — Designed to have minimal impact on application performance during monitoring. ## Philosophy The agent is built to provide comprehensive observability with minimal code changes, following Elastic's philosophy of making application performance monitoring accessible and actionable for developers.

Stars426

Forks207

Last commit5 days ago

fiberprometheus

prometheus middleware for Fiber

Stars208

Forks43

Last commit11 days ago