Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

openapi

package

Go to main page

Versions in this module

v0

v0.1.45

Feb 10, 2025

v0.1.44

Feb 10, 2025

v0.1.43

Feb 10, 2025

v0.1.42

Feb 9, 2025

v0.1.41

Feb 9, 2025

v0.1.40

Feb 9, 2025

v0.1.39

Feb 9, 2025

Changes in this version

+ const ParameterInHeader

+ const ParameterInPath

+ const ParameterInQuery

+ var ErrGettingFileFromURL = errors.New("error getting file from url")

+ var ErrUnexpectedFormDataType = errors.New("expected map[string]any for multipart/form-data")

+ var ErrUnexpectedFormURLEncodedType = errors.New("expected map[string]any for x-www-form-urlencoded")

+ func AssertJSONEqual(t *testing.T, expected, actual any)

+ func CreateCURLBody(content any, contentType string) (string, error)

+ func CreateKinSchemaFromString(t *testing.T, jsonSrc string) *openapi3.Schema

+ func CreateOperationFromYAMLFile(t *testing.T, filePath string, target any)

+ func CreateSchemaFromString(t *testing.T, jsonSrc string) *types.Schema

+ func CreateSchemaFromYAMLFile(t *testing.T, filePath string, target any)

+ func EncodeContent(content any, contentType string) ([]byte, error)

+ func FixSchemaTypeTypos(typ string) string

+ func GenerateContentArray(schema *types.Schema, valueReplacer replacer.ValueReplacer, ...) any

+ func GenerateContentFromFileProperties(filePath, contentType string, valueReplacer replacer.ValueReplacer) []byte

+ func GenerateContentFromSchema(schema *types.Schema, valueReplacer replacer.ValueReplacer, ...) any

+ func GenerateContentObject(schema *types.Schema, valueReplacer replacer.ValueReplacer, ...) any

+ func GenerateRequestHeaders(parameters Parameters, valueReplacer replacer.ValueReplacer) map[string]any

+ func GenerateResponseHeaders(headers Headers, valueReplacer replacer.ValueReplacer) http.Header

+ func GetJSONPair(expected, actual any) (string, string)

+ func GetOpenAPITypeFromValue(value any) string

+ func NewSchemaFromKin(schema *openapi3.Schema, parseConfig *config.ParseConfig) *types.Schema

+ func TransformHTTPCode(httpCode string) int

+ type AuthLocation string

+ const AuthLocationHeader

+ const AuthLocationQuery

+ type AuthScheme string

+ const AuthSchemeBasic

+ const AuthSchemeBearer

+ type AuthType string

+ const AuthTypeApiKey

+ const AuthTypeHTTP

+ type CacheOperationAdapter struct

+ func (a *CacheOperationAdapter) GetRequest(securityComponents SecurityComponents) *Request

+ func (a *CacheOperationAdapter) GetResponse() *Response

+ func (a *CacheOperationAdapter) ID() string

+ func (a *CacheOperationAdapter) Unwrap() Operation

+ func (a *CacheOperationAdapter) WithParseConfig(parseConfig *config.ParseConfig) Operation

+ type CacheStorage interface

+ Get func(key string) (any, bool)

+ Set func(key string, value any) error

+ type ContentExample struct

+ CURL string

+ type Document interface

+ FindOperation func(options *OperationDescription) Operation

+ GetResources func() map[string][]string

+ GetSecurity func() SecurityComponents

+ GetVersion func() string

+ type FileProperties struct

+ ContentType string

+ Extension string

+ FileName string

+ FilePath string

+ IsOpenAPI bool

+ Method string

+ Prefix string

+ Resource string

+ ServiceName string

+ Spec Document

+ func GetPropertiesFromFilePath(filePath string, appCfg *config.AppConfig) (*FileProperties, error)

+ func (f *FileProperties) IsEqual(other *FileProperties) bool

+ type GenerateRequestOptions struct

+ Method string

+ Operation Operation

+ Path string

+ PathPrefix string

+ type GeneratedRequest struct

+ Body string

+ ContentSchema *types.Schema

+ ContentType string

+ Examples *ContentExample

+ Headers map[string]any

+ Method string

+ Path string

+ Query string

+ Request *http.Request

+ func NewRequestFromFixedResource(path, method, contentType string, valueReplacer replacer.ValueReplacer) *GeneratedRequest

+ func NewRequestFromOperation(options *GenerateRequestOptions, securityComponents SecurityComponents, ...) *GeneratedRequest

+ type GeneratedResponse struct

+ Content []byte

+ ContentType string

+ Headers http.Header

+ Operation Operation

+ Request *http.Request

+ StatusCode int

+ func NewResponseFromFixedResource(filePath, contentType string, valueReplacer replacer.ValueReplacer) *GeneratedResponse

+ func NewResponseFromOperation(req *http.Request, operation Operation, valueReplacer replacer.ValueReplacer) *GeneratedResponse

+ type Headers map[string]*Parameter

+ type KinDocument struct

+ func NewDocumentFromFile(filePath string) (*KinDocument, error)

+ func (d *KinDocument) FindOperation(options *OperationDescription) Operation

+ func (d *KinDocument) GetResources() map[string][]string

+ func (d *KinDocument) GetSecurity() SecurityComponents

+ func (d *KinDocument) GetVersion() string

+ type KinOperation struct

+ func (op *KinOperation) GetRequest(securityComponents SecurityComponents) *Request

+ func (op *KinOperation) GetResponse() *Response

+ func (op *KinOperation) ID() string

+ func (op *KinOperation) Unwrap() Operation

+ func (op *KinOperation) WithParseConfig(config *config.ParseConfig) Operation

+ type KinValidator struct

+ func NewValidator(_ Document) *KinValidator

+ func (v *KinValidator) ValidateRequest(req *GeneratedRequest) []error

+ func (v *KinValidator) ValidateResponse(res *GeneratedResponse) []error

+ type MemoryStorage struct

+ func NewMemoryStorage() *MemoryStorage

+ func (s *MemoryStorage) Get(key string) (any, bool)

+ func (s *MemoryStorage) Set(key string, value any) error

+ type Operation interface

+ GetRequest func(securityComponents SecurityComponents) *Request

+ GetResponse func() *Response

+ ID func() string

+ Unwrap func() Operation

+ WithParseConfig func(*config.ParseConfig) Operation

+ func NewCacheOperationAdapter(service string, operation Operation, storage CacheStorage) Operation

+ type OperationDescription struct

+ Method string

+ Resource string

+ Service string

+ type Parameter struct

+ Example any

+ In string

+ Name string

+ Required bool

+ Schema *types.Schema

+ type Parameters []*Parameter

+ type Request struct

+ Body *RequestBody

+ Parameters Parameters

+ type RequestBody struct

+ Schema *types.Schema

+ Type string

+ type Response struct

+ Content *types.Schema

+ ContentType string

+ Headers Headers

+ StatusCode int

+ type SchemaWithContentType struct

+ ContentType string

+ Schema *types.Schema

+ type SecurityComponent struct

+ In AuthLocation

+ Name string

+ Scheme AuthScheme

+ Type AuthType

+ type SecurityComponents map[string]*SecurityComponent

+ type UploadedFile struct

+ Content []byte

+ Extension string

+ Filename string

+ Size int64

+ func GetRequestFile(r *http.Request, fieldName string) (*UploadedFile, error)