Page History
Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
Div | ||||||
---|---|---|---|---|---|---|
| ||||||
|
Tagged Values
Multiexcerpt | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||
<<E2ERESTService>>Stereotype <<E2ERESTService>> is used in the component diagram to mark a service as REST service.
|
...
|
...
|
...
|
...
|
...
|
...
|
...
|
...
<<E2ERESTPortType>>
Stereotype <<E2ERESTPortType>> is used on a class to mark it as REST port type, the root element of a REST service structure.
|
...
|
|
...
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 |
---|
...
<<E2ERESTPortType>>Stereotype <<E2ERESTPortType>> is used on a class to mark it as REST port type, the root element of a REST service structure.
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.
|
...
<<REST>>Stereotype <<REST>> is used on a <<RESTResource>> class method to mark it as REST method, part of a REST service structure.
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.
|
...
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.
<<RESTOperationTag>>With <<RESTOperationTag>> you can group your REST methods. Refer to Tagging REST Operations for more details.
<<RESTError>>
<<RESTResponseDefinition>>
|
...
|
<<RESTAlias>>
Multiexcerpt | ||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||
|
...
|
...
|
...
|
REST Content Types
The Bridge handles content types as follows:
Multiexcerpt | ||
---|---|---|
| ||
The full matching is done in a "best effort" manner. Given the type format |
REST Adapter Parameters
Multiexcerpt | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
|
REST Utility Functions
Multiexcerpt | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||
Access to HTTP request and response objects is provided through global methods:
|
REST Parameter Types
Multiexcerpt | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Request
Response
RequestOptions
AdapterResponse
Request and Response Types
|
Panel | ||
---|---|---|
| ||
|
Panel | ||
---|---|---|
| ||