loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity
openapi-generator/docs/generators/kotlin-misk.md
Andrew Wilson d81b5a37d1
#20883 - Add new Misk Kotlin OpenAPI Generator (#20885) 
* first pass

* Fix extra new line

* adding generator file

* Run new.sh script

* Fix template directory and ignore failing tests

* fixing up content type

* adding controller impl

* cleanup interface

* typo

* removing bodytype

* adding protos

* fixing 2

* Fix headerParamsSimple

* removing protos etc.

* fixing imports

* removing commented code

* fixing imports

* fixing return

* fixing file

* adding comment

* remove adminapi

* move to jakarta

* reverting break

* fixing httpMethods

* pushing mediaTypes

* Adds gradle mustache templates

* Setup simple build.gradle.kts

* Adds basic model.mustache for model generation

* fixing summary

* fixing summary 2

* Removes unnecesssary line

* fixing return type

* fixing override

* fixing httpcall

* Delete proto folder creation

* fixing return type

* fixing void return type

* fixing space

* removing reactive

* removing imports

* Fixing spacing

* Fixing tabbing

* fixing headers

* add comment

* Adds unit tests

* cleanup

* Correct getHelp() description

* cleanup 2

* removiing pathParams files

* fixup

* fixup 3

* removing more files

* Adds GitHub Workflow generation

* removing form params as not required

* Adds tests for OptionsProvider

* Renamed file to match

* remove whitespace

* remove whitespace

* adding documentation

* adding documentation

* removing swagger annotations

* adding tests

* Adds Guice Module

* Grab OpenAPI title to generate module name

* Revert "Grab OpenAPI title to generate module name"

This reverts commit 9c9b935f5dbee6e0974ebf66b4f611f107df70c2.

* Update sample

* Removes moduleFileName additional property

* adding tests

* adding tests 2

* adding tests 3

* adding tests 4

* added media types

* re-adding tests

* fixing camelcase

* fixing mediatypes

* default mediatype

* adding validation

* adding validation

* removing swagger

* adding gradle dependency

* adding gradle dependency

* fixing types

* fixing return types

* fixing tests

* final fixes

* tweaks

* fixing file etc.

* Update samples/ folder

* fixing jakarta

* fixing jakarta 2

* fixing impl

* Fix unit tests

* fixing jakarta

* fixing jakarta 2

* final final final changes

* Fix initialization of BigDecimal for default values

* update samples, docs

* fixing RequestHeader

* fixing RequestHeader 2

* fixing RequestHeader 2

* add validateSpec=false

* fix pom version

---------

Co-authored-by: Guido Arnau <guido@squareup.com>
Co-authored-by: William Cheng <wing328hk@gmail.com>
2025-03-25 22:43:30 +08:00

7.1 KiB
Raw Blame History

title
Documentation for the kotlin-misk Generator

METADATA

Property Value Notes
generator name kotlin-misk pass this to the generate command after -g
generator stability STABLE
generator type SERVER
generator language Kotlin
generator default templating engine mustache
helpTxt Generates a kotlin-misk server.

CONFIG OPTIONS

These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to configuration docs for more details.

Option Description Values Default
additionalModelTypeAnnotations Additional annotations for model type(class level annotations). List separated by semicolon(;) or new line (Linux or Windows) null
apiSuffix suffix for api classes Api
artifactId Generated artifact id (name of jar). null
artifactVersion Generated artifact's package version. 1.0.0
enumPropertyNaming Naming convention for enum properties: 'camelCase', 'PascalCase', 'snake_case', 'UPPERCASE', and 'original' original
groupId Generated artifact package's organization (i.e. maven groupId). org.openapitools
modelMutable Create mutable models false
moduleClassName Name of the generated module class OpenApiModule
packageName Generated artifact package name. org.openapitools
parcelizeModels toggle "@Parcelize" for generated models null
serializableModel boolean - toggle "implements Serializable" for generated models null
sortModelPropertiesByRequiredFlag Sort model properties to place required parameters before optional parameters. null
sortParamsByRequiredFlag Sort method arguments to place required parameters before optional parameters. null
sourceFolder source folder for generated code src/main/kotlin
useBeanValidation Use BeanValidation API annotations to validate data types true

IMPORT MAPPING

Type/Alias Imports
BigDecimal java.math.BigDecimal
Date java.time.LocalDate
DateTime java.time.OffsetDateTime
File java.io.File
LocalDate java.time.LocalDate
LocalDateTime java.time.LocalDateTime
LocalTime java.time.LocalTime
Timestamp java.sql.Timestamp
URI java.net.URI
UUID java.util.UUID

INSTANTIATION TYPES

Type/Alias Instantiated By
array kotlin.collections.ArrayList
list kotlin.collections.ArrayList
map kotlin.collections.HashMap

LANGUAGE PRIMITIVES

  • kotlin.Array
  • kotlin.Boolean
  • kotlin.Byte
  • kotlin.ByteArray
  • kotlin.Char
  • kotlin.Double
  • kotlin.Float
  • kotlin.Int
  • kotlin.Long
  • kotlin.Short
  • kotlin.String
  • kotlin.collections.List
  • kotlin.collections.Map
  • kotlin.collections.MutableList
  • kotlin.collections.MutableMap
  • kotlin.collections.MutableSet
  • kotlin.collections.Set

RESERVED WORDS

  • ApiResponse
  • abstract
  • actual
  • annotation
  • as
  • break
  • class
  • companion
  • const
  • constructor
  • continue
  • contract
  • crossinline
  • data
  • delegate
  • do
  • dynamic
  • else
  • enum
  • expect
  • external
  • false
  • field
  • final
  • finally
  • for
  • fun
  • if
  • import
  • in
  • infix
  • init
  • inline
  • inner
  • interface
  • internal
  • is
  • it
  • lateinit
  • noinline
  • null
  • object
  • open
  • operator
  • out
  • override
  • package
  • param
  • private
  • property
  • protected
  • public
  • receiver
  • reified
  • return
  • sealed
  • setparam
  • super
  • suspend
  • tailrec
  • this
  • throw
  • true
  • try
  • typealias
  • typeof
  • val
  • value
  • var
  • vararg
  • when
  • where
  • while

FEATURE SET

Client Modification Feature

Name Supported Defined By
BasePath ✗ ToolingExtension
Authorizations ✗ ToolingExtension
UserAgent ✗ ToolingExtension
MockServer ✗ ToolingExtension

Data Type Feature

Name Supported Defined 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
Uuid ✗
Array ✓ OAS2,OAS3
Null ✗ OAS3
AnyType ✗ OAS2,OAS3
Object ✓ 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

Name Supported Defined By
Readme ✓ ToolingExtension
Model ✓ ToolingExtension
Api ✓ ToolingExtension

Global Feature

Name Supported Defined 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

Name Supported Defined By
Path ✓ OAS2,OAS3
Query ✓ OAS2,OAS3
Header ✓ OAS2,OAS3
Body ✓ OAS2
FormUnencoded ✓ OAS2
FormMultipart ✓ OAS2
Cookie ✓ OAS3

Schema Support Feature

Name Supported Defined By
Simple ✓ OAS2,OAS3
Composite ✓ OAS2,OAS3
Polymorphism ✗ OAS2,OAS3
Union ✗ OAS3
allOf ✗ OAS2,OAS3
anyOf ✗ OAS3
oneOf ✗ OAS3
not ✗ OAS3

Security Feature

Name Supported Defined 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
SignatureAuth ✗ OAS3
AWSV4Signature ✗ ToolingExtension

Wire Format Feature

Name Supported Defined By
JSON ✗ OAS2,OAS3
XML ✗ OAS2,OAS3
PROTOBUF ✓ ToolingExtension
Custom ✗ OAS2,OAS3