• Home
• io.vertx
• vertx-web-api-service
• 4.0.0.Beta1
• source code

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

x-web-api-service.4.0.0.Beta1.source-code.dataobjects.adoc Maven / Gradle / Ivy

= Cheatsheets

[[ServiceRequest]]
== ServiceRequest

++++
 Data object that encapsulates all informations about an HTTP Request
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[extra]]`@extra`|`Json object`|+++
Get extra payload
+++
|[[params]]`@params`|`Json object`|+++
Get request parsedParameters as JSON
+++
|[[user]]`@user`|`Json object`|+++
Get request principal user as routingContext.user().principal(), null if no user is authenticated
+++
|===

[[ServiceResponse]]
== ServiceResponse

++++
 Data object that encapsulates all informations about an HTTP Response
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[payload]]`@payload`|`Buffer`|-
|[[statusCode]]`@statusCode`|`Number (Integer)`|-
|[[statusMessage]]`@statusMessage`|`String`|-
|===