Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: broken excerpt fixed

...

Multiexcerpt
MultiExcerptNameREST_Service

<<E2ERESTService>>

Stereotype <<E2ERESTService>> is used in the component diagram to mark a service as REST service.

Multiexcerpt
MultiExcerptNameE2ERESTService
Tagged ValueDescriptionAllowed Values
portDefines the machine port number the service is binding to. This port number can be given at service level only.any number
Using ports below 1024 may require additional privileges.
tracePortDefines the shadow port of the service used for tracing.any number (default is service port + 40000)
tokenType

Mark the service as to use token authorization. The E2E 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.

noneDo not use token authorization.
API KeyUse API key authorization.
tokenHeaderNameDefines the name of the header that will transport the token. This tagged value is only relevant, if token authorization is enabled at all. The token header name will be presented as the name of the header field that can be entered in the E2E REST Test Tool. Refer also to tokenType for more information.A valid HTTP header name (according to RFC2616/RFC7230).
useBasicAuth

Mark the service as to use basic authentication mechanisms. The E2E 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.

trueEnable basic authentication.
falseDisable basic authentication (default).
jsonKeepNulls
Multiexcerpt
MultiExcerptNamejsonKeepNulls

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).

trueRender attributes with NULL values to the REST response.
falseLeave out attributes with NULL values in the REST response (default).
jsonCompact
Multiexcerpt
MultiExcerptNamejsonCompact

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.

trueGenerate compact JSON (default).
falseGenerate pretty JSON.

<<E2ERESTPortType>>

Stereotype <<E2ERESTPortType>> is used on a class to mark it as REST port type, the root element of a REST service structure.

Multiexcerpt
MultiExcerptNameE2ERESTPortType
Tagged ValueDescriptionAllowed Values
pathDefines the path to this rest interface. If empty, the path is derived from the package structure.nonepath of the package structure will be used, e.g. /Services/SupportCase/SupportAPI
any valid path stringpath string starting with "/", e.g. /support
errorClassAssigns a user-defined <<RESTError>> class to the REST interface. This class should be set in case of error and given back via the REST response.any complex type describing the structure of the error
apiVersionDefines the API version this port type provides (for documentation purposes only).any string

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.

Multiexcerpt
MultiExcerptNameRESTResource
Tagged ValueDescriptionAllowed Values
relativePathDefines the path of the REST resource or collection in relation to the parent resource . You can provide a static path, or a dynamic path using the notation :<name of a REST Parameter>. You may also provide a combination of both.nonethe name of the REST resource will be used, e.g. /supportcases
any valid stringthe given name will be used
a dynamic path supplying a REST parameterdynamic path, the value of the REST parameter will be passed to the REST methods, e.g. :id

<<REST>>

Stereotype <<REST>> is used on a <<RESTResource>> class method to mark it as REST method, part of a REST service structure.

Multiexcerpt
MultiExcerptNamenote_RESTOperation
Note
iconfalse

<<REST>> is the stereotype to apply to a REST method. Do not confuse with <<RESTOperation>>, which is used for RESTful HTTP services as described on RESTful HTTP Service.
The latter approach is recommended only, if you want to use content types different to JSON and XML.

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.

Multiexcerpt
MultiExcerptNameREST
Tagged ValueDescriptionAllowed Values
httpMethod

Provide the HTTP method of this REST method should respond to.

a valid HTTP methodGET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS
none
  • method name, if it is one of: GET, POST, PUT, DELETE, PATCH, HEAD, OPTIONS (with optional trailing '/')
  • GET otherwise
relativePathDefines the path of the REST method in relation to the parent resource.noneThe name of the REST method will be used.
any valid stringThe given name will be used. The relative path may also contain variables (REST path parameters, specified as :<variable name>) and can be segmented like e.g. /date=:<a date variable>.
isVerbatimPath

Disable most of the path normalization. All escaping must be done manually, leading or trailing whitespaces are preserved.

Note
iconfalse

This a REST Adapter setting and has no effect on REST service.

truePath should be treated as verbatim, path normalization is disabled.
false (default)Path should be URL encoded.
blobBodyContentType
Multiexcerpt
MultiExcerptNameblobBodyContentType
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.
a valid MIME-typee.g. application/msexcel
Default is application/octet-stream if not specified.

Anchor
rest_parameter
rest_parameter
<<RESTParameter>>

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.

Multiexcerpt
MultiExcerptNameRESTParameter
Tagged ValueDescriptionAllowed ValuesAllowed REST MethodsAllowed TypesHints and Limitations
externalNameDefines an external name for the REST parameterany stringUse this, when wanting to access a REST service that has parameter names with special characters. In this case, set this name (e.g. ugly@parameter-name) to externalName and give a better name. So you will not have to escape the parameter every time you use it.
inDefines how the parameter will be passed to the REST method. This tag is mandatory.queryvia a query stringallall simple types and Array of simple typeUnknown parameters will be ignored, known will be passed to the method after being URL-decoded.
pathvia the REST resource pathallInteger, Float, String, Boolean, DateTimePath parameters are all required. All path parameters must be consumed by the called method and the parameter names must be the same as the path segment identifiers (without colon).
bodyvia the REST call bodyPOST, PUT, PATCHa complex type and ArrayA REST method can have only one body parameter.
headervia the REST call headerallall simple types and Array of simple typeUnknown parameters will be ignored, known will be passed to the method.
multiplicityDefines whether the parameter is required, or not.0..1

Parameter is not required.

Note
iconfalse

Path parameters are always required.

1Parameter is required.

<<RESTOperationTag>>

With <<RESTOperationTag>> you can group your REST methods. Refer to Tagging REST Operations for more details.

Multiexcerpt
MultiExcerptNameRESTOperationTag
Tagged ValueDescription
Allowed Values
nameDefines the name of the tag. This name will be displayed in the E2E REST Test Tool as a group heading.any string
descriptionYou can add a short description of the tag that will be displayed in the E2E REST Test Tool together with the heading.any string
externalDocumentationDescriptionYou can add a short description of the documentation.These field values will be generated to the OpenAPI descriptor, but are not displayed on the Test UI at the moment.any string
externalDocumentationURLDefines a documentation URL for this tag group.a valid URL
orderDefines the order in which the tag groups will be displayed on the screen. Tag groups with empty order will be displayed last.any number

<<RESTError>>

Multiexcerpt
MultiExcerptNameRESTError

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.
You can report errors back to the caller using something like:

Code Block
local response = getRestHttpResponse();
response.responseObject = <my error object>;
response.httpStatus = <a matching http error code>;

<<RESTResponseDefinition>>

Multiexcerpt
MultiExcerptNameRESTResponseDefinition

Use dependencies with stereotype <<RESTResponseDefinition>> are used to connect REST resources with REST error classes.

Tagged ValueDescriptionAllowed Values
nameSpecify an HTTP status code. For this status code, the default error class will be overwritten by the specific error class.a specific HTTP status codee.g. 401
a patterne.g. 40? or 4??
all status codes???
blobBodyContentType
Multiexcerpt include
MultiExcerptNameblobBodyContentType
PageWithExcerptXBRIDGE2:@self
a valid MIME-typee.g. application/msexcel
Default is application/octet-stream if not specified.

...