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 / swaggerImport
Service: swaggerImport
This service is responsible for importing and processing swagger and open api collection and generating client and server components based on the input.
Input Parameter:
| Name | Type | Description |
| generateClient: | Boolean | A boolean flag that, when set to true, indicates that client-related services should be generated based on the Swagger content. |
| generateServerStub: | Boolean | A boolean flag that, when set to true, indicates that client-related services should be generated based on the imported content. |
| packageName: | String | The name of the package or namespace to be used for organizing the generated client and server components. |
| payload: | Document | The payload parameter expects a Swagger or OpenAPI document as its input. This document should conform to the Swagger or OpenAPI specification and provide a comprehensive description. |
Output Parameter:
| Name | Type | Description |
| status: | Boolean | |
| clientServices: | Document | A document containing the generated client-related services or components based on the Swagger content. |
| serverServices: | Document | A document containing the generated server-related services or components based on the Swagger content |