OpenAPI Generator

OpenAPI Generator

  • Get Started
  • Generators
  • Roadmap
  • Team
  • FAQ
  • Blog

Config Options for haskell-http-client

OptionDescriptionValuesDefault
allowFromJsonNullsallow JSON Null during model decoding from JSONtrue
allowNonUniqueOperationIdsallow different API modules to contain the same operationId. Each API must be imported qualifiedfalse
allowToJsonNullsallow emitting JSON Null during model encoding to JSONfalse
allowUnicodeIdentifiersboolean, toggles whether unicode identifiers are allowed in names or not, default is falsefalse
baseModuleSet the base module namespacenull
cabalPackageSet the cabal package name, which consists of one or more alphanumeric words separated by hyphensnull
cabalVersionSet the cabal version number, consisting of a sequence of one or more integers separated by dotsnull
configTypeSet the name of the type used for configurationnull
customTestInstanceModuletest module used to provide typeclass instances for types not known by the generatornull
dateFormatformat string used to parse/render a date%Y-%m-%d
dateTimeFormatformat string used to parse/render a datetimenull
dateTimeParseFormatoverrides the format string used to parse a datetimenull
ensureUniqueParamsWhether to ensure parameter names are unique in an operation (rename parameters that are not).true
generateEnumsGenerate specific datatypes for OpenAPI enumstrue
generateFormUrlEncodedInstancesGenerate FromForm/ToForm instances for models that are used by operations that produce or consume application/x-www-form-urlencodedtrue
generateLensesGenerate Lens optics for Modelstrue
generateModelConstructorsGenerate smart constructors (only supply required fields) for modelstrue
hideGenerationTimestampHides the generation timestamp when files are generated.true
inlineMimeTypesInline (hardcode) the content-type and accept parameters on operations, when there is only 1 optiontrue
modelDerivingAdditional classes to include in the deriving() clause of Modelsnull
prependFormOrBodyParametersAdd form or body parameters to the beginning of the parameter list.false
requestTypeSet the name of the type used to generate requestsnull
sortModelPropertiesByRequiredFlagSort model properties to place required parameters before optional parameters.true
sortParamsByRequiredFlagSort method arguments to place required parameters before optional parameters.true
strictFieldsAdd strictness annotations to all model fieldstrue
useKatipSets the default value for the UseKatip cabal flag. If true, the katip package provides logging instead of monad-loggertrue

IMPORT MAPPING

Type/AliasImports

INSTANTIATION TYPES

Type/AliasInstantiated By

LANGUAGE PRIMITIVES

  • Bool
  • Char
  • Double
  • FilePath
  • Float
  • Int
  • Integer
  • List
  • String
  • Text

RESERVED WORDS

  • accept
  • as
  • case
  • class
  • contenttype
  • data
  • default
  • deriving
  • do
  • else
  • family
  • forall
  • foreign
  • hiding
  • if
  • import
  • in
  • infix
  • infixl
  • infixr
  • instance
  • let
  • mdo
  • module
  • newtype
  • of
  • proc
  • pure
  • qualified
  • rec
  • return
  • then
  • type
  • where

FEATURE SET

Client Modification Feature

NameSupportedDefined By
BasePath✓ToolingExtension
Authorizations✗ToolingExtension
UserAgent✓ToolingExtension

Data Type Feature

NameSupportedDefined By
Custom✗OAS2,OAS3
Int32✓OAS2,OAS3
Int64✓OAS2,OAS3
Float✓OAS2,OAS3
Double✓OAS2,OAS3
Decimal✓ToolingExtension
String✓OAS2,OAS3
Byte✓OAS2,OAS3
Binary✓OAS2,OAS3
Boolean✓OAS2,OAS3
Date✓OAS2,OAS3
DateTime✓OAS2,OAS3
Password✓OAS2,OAS3
File✓OAS2
Array✓OAS2,OAS3
Maps✓ToolingExtension
CollectionFormat✓OAS2
CollectionFormatMulti✓OAS2
Enum✓OAS2,OAS3
ArrayOfEnum✓ToolingExtension
ArrayOfModel✓ToolingExtension
ArrayOfCollectionOfPrimitives✓ToolingExtension
ArrayOfCollectionOfModel✓ToolingExtension
ArrayOfCollectionOfEnum✓ToolingExtension
MapOfEnum✓ToolingExtension
MapOfModel✓ToolingExtension
MapOfCollectionOfPrimitives✓ToolingExtension
MapOfCollectionOfModel✓ToolingExtension
MapOfCollectionOfEnum✓ToolingExtension

Documentation Feature

NameSupportedDefined By
Readme✓ToolingExtension
Model✓ToolingExtension
Api✓ToolingExtension

Global Feature

NameSupportedDefined By
Host✓OAS2,OAS3
BasePath✓OAS2,OAS3
Info✓OAS2,OAS3
Schemes✗OAS2,OAS3
PartialSchemes✓OAS2,OAS3
Consumes✓OAS2
Produces✓OAS2
ExternalDocumentation✓OAS2,OAS3
Examples✓OAS2,OAS3
XMLStructureDefinitions✗OAS2,OAS3
MultiServer✗OAS3
ParameterizedServer✗OAS3
ParameterStyling✗OAS3
Callbacks✗OAS3
LinkObjects✗OAS3

Parameter Feature

NameSupportedDefined By
Path✓OAS2,OAS3
Query✓OAS2,OAS3
Header✓OAS2,OAS3
Body✓OAS2
FormUnencoded✓OAS2
FormMultipart✓OAS2
Cookie✗OAS3

Schema Support Feature

NameSupportedDefined By
Simple✓OAS2,OAS3
Composite✓OAS2,OAS3
Polymorphism✗OAS2,OAS3
Union✗OAS3

Security Feature

NameSupportedDefined By
BasicAuth✓OAS2,OAS3
ApiKey✓OAS2,OAS3
OpenIDConnect✗OAS3
BearerToken✗OAS3
OAuth2_Implicit✓OAS2,OAS3
OAuth2_Password✗OAS2,OAS3
OAuth2_ClientCredentials✗OAS2,OAS3
OAuth2_AuthorizationCode✗OAS2,OAS3

Wire Format Feature

NameSupportedDefined By
JSON✓OAS2,OAS3
XML✓OAS2,OAS3
PROTOBUF✗ToolingExtension
Custom✗OAS2,OAS3
Last updated on 2/2/2020
  • IMPORT MAPPING
  • INSTANTIATION TYPES
  • LANGUAGE PRIMITIVES
  • RESERVED WORDS
  • FEATURE SET
    • Client Modification Feature
    • Data Type Feature
    • Documentation Feature
    • Global Feature
    • Parameter Feature
    • Schema Support Feature
    • Security Feature
    • Wire Format Feature
OpenAPI Generator
Docs
Customizing GeneratorsWorkflow Integrations
Community
User ShowcaseStack OverflowChat RoomTwitter
More
BlogGitHub RepoStar
Copyright © 2020 OpenAPI-Generator Contributors (https://openapi-generator.tech). (Both "OpenAPI Tools" (https://OpenAPITools.org) and "OpenAPI Generator" are not affiliated with OpenAPI Initiative (OAI))