Docs Menu
- Introduction to Syncloop
- Quick Start Syncloop
-
API Developer Guide
-
middleware
-
pub
- adapter
- authorization
- client
- collection
- date
- docList
- file
- graphQL
- io
- json
- jwt
- math
- platform
- security
- server
- service
- specs
- sql
- string
- bytesToHexString
- bytesToString
- compare
- compareStrings
- concat
- decodeBase64
- decodeHTML
- encodeBase64
- encodeHTML
- equals
- equalsIgnoreCase
- escapeSQL
- fromXML
- htmlDecode
- htmlEncode
- indexOf
- isAlphanumeric
- isBlank
- isDate
- isEmpty
- isNumber
- length
- lookupDict
- maskString
- messageDigest
- messageFormat
- NullOrWhiteSpc
- objectToString
- padLeft
- replace
- rightPad
- stringConcat
- stringIndexOf
- stringToBytes
- subString
- TextArrayToTextString
- TextListCollector
- tokenize
- toLower
- toString
- toUpper
- trim
- urlDecode
- tenant
- util
- xml
-
pub
-
middleware
- User Guide
- FAQs
- Java Docs
- Blogs
API Developer Guide / middleware / pub / specs / swagger / v3 / GenerateSwagger
Service: GenerateSwagger
This service generates an OpenAPI document based on the specified fully qualified names (fqns) and offers the option to make it downloadable.
Input Parameter:
| Name | Type | Description |
| fqns: | String Array | An array of fully qualified names (fqns) representing the components that contribute to the generation of the OpenAPI document. |
| isDownloadable: | Boolean | A boolean flag that, when set to true, indicates that the generated OpenAPI document should be available for download. |
Output Parameter:
| Name | Type | Description |
| openAPI: | String | The generated OpenAPI document. If isDownloadable is set to true, this document can be downloaded. |