oapi-codegen

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

Non-config changes

• NewRequest has been modified to NewRequestWithContext

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

Extend responses struct

For our use case we'd like to add an aggregated error if the response isn't 200

In order to do that the response struct can be extended with the following config

Example:

output-options:
  extend-response:
  - field: HasError
    type: error
    description: "Aggregated error"
    apply-to: ["*"]
    imports: ["errors"]

which generates:

type ListClustersResponse struct {
  Body         []byte
  HTTPResponse *http.Response
  // ...
  HasError     error // Aggregated error
}

Custom Doer interface

in order to load a Doer interface from another package, the following configuration can be added

output-options:
  custom-doer:
    enabled: true
    import: skeclient "github.com/do87/oapi-codegen/examples/ske-client"
    name: "skeclient.HttpRequestDoer"

Copy supporting files

output-options:
  copy:
  - from: wait/cluster/wait.go
    to: cluster/wait.go
    tidy: 
    - replace: "cluster."
      with:
      all: true

Extend WithResponse Structs

output-options:
  extend-response:
  - field: HasError
    type: error
    description: "Aggregated error"
    apply-to: ["*"]
    set: "nil"

Will result in:

type CreateOrUpdateClusterResponse struct {
  Body         []byte
  HTTPResponse *http.Response
  // ...
  HasError     error // Aggregated error
}

This is just one of the response structs. because the matching is "*" it'll be added to all of them.

And because 'set' has a value, the corresponding Parse method will be modified to:

// ParseCreateOrUpdateClusterResponse parses an HTTP response from a CreateOrUpdateClusterWithResponse call
func (c *ClientWithResponses) ParseCreateOrUpdateClusterResponse(rsp *http.Response) (*CreateOrUpdateClusterResponse, error) {
  // ...

  response := &CreateOrUpdateClusterResponse{
    Body:         bodyBytes,
    HTTPResponse: rsp,
  }
  response.HasError = nil