README
¶
OpenAPI Client and Server Code Generator
This repo is a fork of deepmap/oapi-codegen
Only the changes from the original repo are documented below
Spec tidying
In cases where the OpenAPI spec isn't created by whomever generates the client, a "tidy" functionality is used to make the client more readable / styled as needed
In a configuration file, the following code can be added:
tidy:
verbose: false
functions:
- replace: service_
with:
prefix: true
params:
- replace: Id
with: ID
suffix: true
schemas:
- replace: Cpu
with: CPU
match: true
Splitting client code by tags
the config has been extended to support splitting the client code into multiple directories and files
Example:
output-options:
split-by-tags:
verbose: true
enabled: true
theres also an options to add a list under split-by-tags of includes or excludes
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
examples
|
|
|
authenticated-api/echo/api
Package api provides primitives to interact with the openapi HTTP API.
|
Package api provides primitives to interact with the openapi HTTP API. |
|
custom-client-type
Package customclienttype provides primitives to interact with the openapi HTTP API.
|
Package customclienttype provides primitives to interact with the openapi HTTP API. |
|
petstore-expanded
Package petstore provides primitives to interact with the openapi HTTP API.
|
Package petstore provides primitives to interact with the openapi HTTP API. |
|
petstore-expanded/chi/api
Package api provides primitives to interact with the openapi HTTP API.
|
Package api provides primitives to interact with the openapi HTTP API. |
|
petstore-expanded/echo
This is an example of implementing the Pet Store from the OpenAPI documentation found at: https://github.com/OAI/OpenAPI-Specification/blob/master/examples/v3.0/petstore.yaml
|
This is an example of implementing the Pet Store from the OpenAPI documentation found at: https://github.com/OAI/OpenAPI-Specification/blob/master/examples/v3.0/petstore.yaml |
|
petstore-expanded/echo/api
Package api provides primitives to interact with the openapi HTTP API.
|
Package api provides primitives to interact with the openapi HTTP API. |
|
petstore-expanded/echo/api/models
Package models provides primitives to interact with the openapi HTTP API.
|
Package models provides primitives to interact with the openapi HTTP API. |
|
petstore-expanded/gin/api
Package api provides primitives to interact with the openapi HTTP API.
|
Package api provides primitives to interact with the openapi HTTP API. |
|
petstore-expanded/gorilla/api
Package api provides primitives to interact with the openapi HTTP API.
|
Package api provides primitives to interact with the openapi HTTP API. |
|
petstore-expanded/strict/api
Package api provides primitives to interact with the openapi HTTP API.
|
Package api provides primitives to interact with the openapi HTTP API. |
|
ske-client
Package ske provides primitives to interact with the openapi HTTP API.
|
Package ske provides primitives to interact with the openapi HTTP API. |
|
ske-client/cluster
Package cluster provides primitives to interact with the openapi HTTP API.
|
Package cluster provides primitives to interact with the openapi HTTP API. |
|
ske-client/credentials
Package credentials provides primitives to interact with the openapi HTTP API.
|
Package credentials provides primitives to interact with the openapi HTTP API. |
|
ske-client/operation
Package operation provides primitives to interact with the openapi HTTP API.
|
Package operation provides primitives to interact with the openapi HTTP API. |
|
ske-client/project
Package project provides primitives to interact with the openapi HTTP API.
|
Package project provides primitives to interact with the openapi HTTP API. |
|
ske-client/provider-options
Package provideroptions provides primitives to interact with the openapi HTTP API.
|
Package provideroptions provides primitives to interact with the openapi HTTP API. |
|
internal
|
|
|
test/all_of/v1
Package v1 provides primitives to interact with the openapi HTTP API.
|
Package v1 provides primitives to interact with the openapi HTTP API. |
|
test/all_of/v2
Package v2 provides primitives to interact with the openapi HTTP API.
|
Package v2 provides primitives to interact with the openapi HTTP API. |
|
test/any_of/param
Package param provides primitives to interact with the openapi HTTP API.
|
Package param provides primitives to interact with the openapi HTTP API. |
|
test/client
Package client provides primitives to interact with the openapi HTTP API.
|
Package client provides primitives to interact with the openapi HTTP API. |
|
test/components
Package components provides primitives to interact with the openapi HTTP API.
|
Package components provides primitives to interact with the openapi HTTP API. |
|
test/externalref
Package externalref provides primitives to interact with the openapi HTTP API.
|
Package externalref provides primitives to interact with the openapi HTTP API. |
|
test/externalref/packageA
Package packagea provides primitives to interact with the openapi HTTP API.
|
Package packagea provides primitives to interact with the openapi HTTP API. |
|
test/externalref/packageB
Package packageb provides primitives to interact with the openapi HTTP API.
|
Package packageb provides primitives to interact with the openapi HTTP API. |
|
test/issues/issue-312
Package issue312 provides primitives to interact with the openapi HTTP API.
|
Package issue312 provides primitives to interact with the openapi HTTP API. |
|
test/issues/issue-52
Package issue52 provides primitives to interact with the openapi HTTP API.
|
Package issue52 provides primitives to interact with the openapi HTTP API. |
|
test/issues/issue-579
Package issue579 provides primitives to interact with the openapi HTTP API.
|
Package issue579 provides primitives to interact with the openapi HTTP API. |
|
test/issues/issue-832
Package issue_832 provides primitives to interact with the openapi HTTP API.
|
Package issue_832 provides primitives to interact with the openapi HTTP API. |
|
test/issues/issue-grab_import_names
Package grabimportnames provides primitives to interact with the openapi HTTP API.
|
Package grabimportnames provides primitives to interact with the openapi HTTP API. |
|
test/issues/issue-head-digit-of-httpheader
Package headdigitofhttpheader provides primitives to interact with the openapi HTTP API.
|
Package headdigitofhttpheader provides primitives to interact with the openapi HTTP API. |
|
test/issues/issue-head-digit-of-operation-id
Package head_digit_of_operation_id provides primitives to interact with the openapi HTTP API.
|
Package head_digit_of_operation_id provides primitives to interact with the openapi HTTP API. |
|
test/issues/issue-illegal_enum_names
Package illegalenumnames provides primitives to interact with the openapi HTTP API.
|
Package illegalenumnames provides primitives to interact with the openapi HTTP API. |
|
test/issues/issue-removed-external-ref/gen/spec_base
Package spec_base provides primitives to interact with the openapi HTTP API.
|
Package spec_base provides primitives to interact with the openapi HTTP API. |
|
test/issues/issue-removed-external-ref/gen/spec_ext
Package spec_ext provides primitives to interact with the openapi HTTP API.
|
Package spec_ext provides primitives to interact with the openapi HTTP API. |
|
test/parameters
Package parameters provides primitives to interact with the openapi HTTP API.
|
Package parameters provides primitives to interact with the openapi HTTP API. |
|
test/schemas
Package schemas provides primitives to interact with the openapi HTTP API.
|
Package schemas provides primitives to interact with the openapi HTTP API. |
|
test/server
Package server provides primitives to interact with the openapi HTTP API.
|
Package server provides primitives to interact with the openapi HTTP API. |
|
test/strict-server/chi
Package api provides primitives to interact with the openapi HTTP API.
|
Package api provides primitives to interact with the openapi HTTP API. |
|
test/strict-server/client
Package api provides primitives to interact with the openapi HTTP API.
|
Package api provides primitives to interact with the openapi HTTP API. |
|
test/strict-server/echo
Package api provides primitives to interact with the openapi HTTP API.
|
Package api provides primitives to interact with the openapi HTTP API. |
|
test/strict-server/gin
Package api provides primitives to interact with the openapi HTTP API.
|
Package api provides primitives to interact with the openapi HTTP API. |
|
pkg
|
|
|
chi-middleware
Package middleware implements middleware function for go-chi or net/http, which validates incoming HTTP requests to make sure that they conform to the given OAPI 3.0 specification.
|
Package middleware implements middleware function for go-chi or net/http, which validates incoming HTTP requests to make sure that they conform to the given OAPI 3.0 specification. |
|
securityprovider
Package securityprovider contains some default securityprovider implementations, which can be used as a RequestEditorFn of a client.
|
Package securityprovider contains some default securityprovider implementations, which can be used as a RequestEditorFn of a client. |
Click to show internal directories.
Click to hide internal directories.