go-swagger/go-swagger
Go Swagger
go-swagger is a toolkit for working with Swagger/OpenAPI 2.0 specifications in Go. It generates server, client, and CLI code from a specification document, and can also produce a specification by scanning annotated Go source code. The project includes a static validation engine that checks documents against the schema and project-specific rules, and a specification transformation pipeline that resolves, flattens, and merges documents.
The toolkit generates both client and server code from the same specification, ensuring consistency in request and response handling. It also produces a command-line tool that maps each API operation to a subcommand, and hosts an interactive documentation server using Swagger UI or ReDoc. Code generation is customizable through user-supplied templates and vendor extensions.
Beyond code generation, the project validates specifications, compares documents for breaking changes, and merges multiple spec files into one. It can generate Markdown documentation and random test data from a specification. The toolkit is distributed as pre-compiled binaries for multiple platforms through GitHub releases and package managers.
Features
- Code from Specification Generators - Generates Go server, client, and CLI code from Swagger/OpenAPI 2.0 specification documents.
- Document Q&A - Generates fully functional Go HTTP servers from Swagger/OpenAPI 2.0 specifications.
- Specification Merging - Resolves references, flattens schemas, or merges multiple Swagger/OpenAPI 2.0 specifications into one.
- OpenAPI Client SDK Generators - Generates fully typed Go API client libraries from Swagger/OpenAPI 2.0 specifications.
- Specification Transformers - Resolves, flattens, or merges Swagger/OpenAPI 2.0 specifications by inlining external references and reorganizing schemas.
- Specification Consolidation - Resolves, flattens, or merges Swagger specification documents to consolidate references and definitions.
- OpenAPI Specification Linters - Checks a Swagger/OpenAPI 2.0 document against the schema and project-specific rules for correctness.
- Spec-Driven Client Generators - Generates a Go client from a Swagger/OpenAPI spec file, providing request and response handling for the described API.
- API-to-CLI Generators - Generates a full CLI tool that maps each API operation to a subcommand.
- Specification from Code Generators - Produces Swagger/OpenAPI 2.0 specifications by scanning annotated Go source code.
- API Authentication Schemes - Generates server and client code that supports Basic Auth, API key, and Bearer token authentication schemes.
- Swagger Document Validators - Checks a Swagger/OpenAPI 2.0 specification against the schema and additional rule sets for correctness.
- Symmetric Code Generators - Generates both client and server code from the same specification, ensuring request/response handling consistency.
- Swagger Specification Validators - Checks a Swagger 2.0 document against the specification and applies extra validation rules to catch common errors.
- OpenAPI Specification Generators - Generates OpenAPI 2.0 specifications by scanning annotated Go source code at compile time.
- Spec-from-Annotation Generators - Scans Go source annotations to produce a complete Swagger specification document.
- Swagger - Generates Go struct definitions with validation from Swagger specification schemas.
- Data Model Generators - Creates Go struct definitions and validators for the schemas defined in a Swagger/OpenAPI 2.0 specification.
- Go Code Generators - Generates a fully typed Go client library from a Swagger specification.
- Specification from Code Generators - Produces Swagger/OpenAPI 2.0 specifications by scanning annotated Go source code.
- Mock Server Generators - Generates fully functional Go HTTP servers with routing and validation from Swagger specifications.
- CLI Command Generators - Produces a command-line tool that maps each API operation to a subcommand from a Swagger specification.
- Specification Validation Schemas - Validates Swagger/OpenAPI 2.0 documents against the specification schema and custom rule sets.
- OpenAPI Specification Validators - Validates Swagger/OpenAPI 2.0 documents against the schema and project-specific rules without runtime execution.
- API Specification Compliance Tools - Checks a Swagger 2.0 document for structural correctness and compliance with the specification.
- Specification from Code Generators - Produces Swagger/OpenAPI 2.0 specifications by scanning annotated Go source code.
- API Client Generators - Generates fully typed Go API client libraries from Swagger/OpenAPI 2.0 specifications.
- Specification Transformers - Resolves references, flattens inline schemas, or merges multiple Swagger/OpenAPI 2.0 specifications into one.
- Specification Validators - Checks a Swagger/OpenAPI 2.0 specification against the schema and project-specific rules, reporting any violations.
- OpenAPI Specification Transformers - Resolves, flattens, and merges Swagger/OpenAPI 2.0 documents through a multi-stage processing pipeline.
- API Documentation Generators - Generates Markdown documentation describing endpoints and models from a Swagger specification.
- Template-Based Code Customizers - Allows overriding default templates and injecting vendor extensions to customize generated code.
- Breaking Change Detectors - Compares two Swagger/OpenAPI 2.0 specifications and reports breaking changes in backward compatibility.
- OpenAPI Specification Comparators - Compares two Swagger specification documents and reports breaking changes in backwards compatibility.
- Frontend API Mocking - Ships a built-in server that hosts a live, interactive UI for an API specification with mock data.
- API Specification UI Rendering - Hosts an interactive Swagger UI documentation page for any given Swagger/OpenAPI 2.0 specification.
- Template-Based Code Customizers - Modifies generated code output through vendor extensions and user-supplied templates.
- Template-Based Code Generators - Allows users to override default code generation templates and inject vendor extensions for tailored output.
- Interactive API Documentation Servers - Hosts an interactive Swagger UI documentation page for any Swagger/OpenAPI 2.0 specification file.
- HTTP Client Configurations - Sets custom headers, transports, and round trippers on the generated client to modify request handling.
- OpenAPI - Compares two Swagger/OpenAPI 2.0 specifications and fails a build if the newer version breaks backward compatibility.
- API Specification Transformers - Resolves references, flattens schemas, and merges multiple Swagger/OpenAPI 2.0 specification files.
- API Specification Breaking Change Detectors - Compares two Swagger/OpenAPI 2.0 specifications and reports breaking changes in backward compatibility.
- JSON Schema Validation - Validates JSON data against JSON Schema Draft 4 definitions with reference resolution.
- API Documentation Hosting - Serves interactive Swagger UI documentation pages for any Swagger/OpenAPI 2.0 specification.
- Interactive API Documentation UIs - Hosts a live Swagger UI or ReDoc interface from a specification file for browsing and testing endpoints.
- Annotated Response Models - Annotates Go structs with swagger:response to specify the schema and content type of API responses.
- Struct-to-Parameter Mappings - Marks struct fields with swagger:params to define path, query, or header parameters for an API operation.
- API Design and Generation - Implementation of Swagger 2.0 for Go services.
- Development Utilities - Implements Swagger 2.0 for Go applications.
- Documentation Tools - Full Swagger 2.0 implementation.
- Frameworks and Libraries - Tools for API documentation, generation, and validation.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
