Page History
Div | ||||||
---|---|---|---|---|---|---|
| ||||||
|
...
Mark the service as to use token authorization. The Bridge REST Test Tool will then present a field to enter the token and put the value into the HTTP headers. Refer also to tokenHeaderName for more information.
You can use both in a REST service: basic authorization and token authorization, see useBasicAuth.
...
Mark the service as to use basic authentication mechanisms. The Bridge REST Test Tool will then present fields to enter the credentials and put the values into the HTTP headers.
You can use both in a REST service: basic authorization and token authorization, see tokeType and tokenHeaderName.
...
Multiexcerpt | ||
---|---|---|
| ||
Builder 6.0.26 When jsonKeepNulls is true, attributes of the REST response object having NULL values will be rendered to the REST response, otherwise they will be left out completely (see also chapter NULL Values). |
...
Multiexcerpt | ||
---|---|---|
| ||
Builder 7.0.0-beta3 When jsonCompact is true, the JSON composer will generate compact JSON, otherwise it will generate pretty JSON. jsonCompact defaults to true - also on re-compile of an older model with Builder as of 7.0.0-beta3. |
...
<<E2ERESTPortType>>
Stereotype <<E2ERESTPortType>> is used on a class to mark it as REST port type, the root element of a REST service structure.
...
MultiExcerptName | E2ERESTPortType |
---|
...
For more information on REST error classes, see <<RESTError>>.
<<RESTResource>>
Stereotype <<RESTResource>> is used on a class to mark it as REST resource, part of a REST service structure.
...
MultiExcerptName | RESTResource |
---|
...
<<REST>>
Stereotype <<REST>> is used on a <<RESTResource>> class method to mark it as REST method, part of a REST service structure.
Multiexcerpt | |||||
---|---|---|---|---|---|
| |||||
|
If the method name is one of GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS (with optional trailing '/'), it will be invoked automatically on its parent resource when an corresponding request is received.
Refer Implementing REST Methods to for more details and some examples.
...
MultiExcerptName | REST |
---|
...
Provide the HTTP method of this REST method should respond to.
...
- method name, if it is one of: GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS (with optional trailing '/')
- GET otherwise
...
Disable most of the path normalization. All escaping must be done manually, leading or trailing whitespaces are preserved.
Info | ||
---|---|---|
| ||
This a REST Adapter setting and has no effect on REST service. |
...
Multiexcerpt | ||
---|---|---|
| ||
Bridge 7.1.0 Specify a default content type for Blob parameters from this endpoint. This information will be generated to the OpenAPI descriptor file and will will set the the "Content-Type" header to this content type. |
...
Stereotype <<RESTParameter>> is used on a <<REST>> method parameter to mark it as REST parameter. Refer to REST Parameters to for more details and some examples.
...
MultiExcerptName | RESTParameter |
---|
...
Parameter is not required.
Info | ||
---|---|---|
| ||
Path parameters are always required. |
...
<<RESTOperationTag>>
With <<RESTOperationTag>> you can group your REST methods. Refer to Tagging REST Operations for more details.
...
MultiExcerptName | RESTOperationTag |
---|
...
<<RESTError>>
Multiexcerpt | ||
---|---|---|
| ||
Stereotype <<RESTError>> is used on a class to mark it as REST error class. Assign such a class to the REST port type (see <<E2ERESTPortType>>) and this class will be used as output in case of error. Each REST port type can have its separate error class.
|
<<RESTResponseDefinition>>
...
MultiExcerptName | RESTResponseDefinition |
---|
Use dependencies with stereotype <<RESTResponseDefinition>> are used to connect REST resources with REST error classes.
...
This information will be generated to the OpenAPI descriptor file and will will set the the "Content-Type" header to this content type.
...
<<RESTAlias>>
...
MultiExcerptName | RESTAlias |
---|
...
Specify here whether you want the REST adapter to throw an exception upon receiving an HTTP error code >= 400.
For older models, if this flag is not present, it will be considered false.
Info | ||
---|---|---|
| ||
ignoreHttpErrors can be overridden via the request options (see Setting REST Request Options). |
...
Specify native cURL options as listed in Setting cURL Options on the URL Adapter .
Use one of the following syntax rules:
- values separated by
','
in one line - values separated by
' '
in one line - list of tagged values
...
...
...
...
...
...