go-openapi
Common documentation for go-openapi projects
This site hosts the shared documentation that applies to all repositories in the go-openapi organization.
Rather than duplicating contributing guidelines, coding style, security policies and licensing across dozens of repositories, we maintain them here as a single source of truth.
What you’ll find here
- Contributing guidelines – how to contribute code, report issues, and sign your work
- Coding style – our stance on linters and code quality
- Code of Conduct – the Contributor Covenant
- Developer Certificate of Origin – signing your commits
- Security policy – how to report vulnerabilities
- License – Apache-2.0
For individual project documentation
Each go-openapi project has its own README and may publish additional project-specific documentation. The guidelines on this site apply uniformly unless a project’s own documentation states otherwise.
| Project | Description | Go docs |
|---|---|---|
| go-openapi/analysis | Spec analyzer, flattener, mixer & differ | pkg.go.dev |
| go-openapi/codescan | Spec generation from source | pkg.go.dev |
| go-openapi/errors | Common error types | pkg.go.dev |
| go-openapi/inflect | English words pluralization (unused now) | pkg.go.dev |
| go-openapi/jsonpointer | jsonpointer that supports structs | pkg.go.dev |
| go-openapi/jsonreference | json reference for go | pkg.go.dev |
| go-openapi/loads | Spec loading | pkg.go.dev |
| go-openapi/runtime | Runtime middleware | pkg.go.dev |
| go-openapi/spec | OpenAPI 2.0 (Swagger) spec model | pkg.go.dev |
| go-openapi/strfmt | String format validations | pkg.go.dev |
| go-openapi/swag | Misc. common utilities | pkg.go.dev |
| go-openapi/testify | Testing toolkit (testify/v2 fork) | pkg.go.dev |
| go-openapi/validate | OpenAPI spec & JSONSchema draft 4 validation | pkg.go.dev |
| go-swagger/examples | Examples & tutorial using go-swagger | |
| go-swagger/go-swagger | Swagger 2.0 implementation |
Community
Join us on Discord for questions, discussions, and announcements.