Hide Comments

The resourceAPI element defines a REST-style API as a collection of resources provided to consuming applications.  The API may optionally be secured by one or more specified security schemes.

Syntax

resourceAPI <resource-api-name> baseURI "<uri>"

[<secured>]

[<collection-resource> | <object-resource>]...

Examples

resourceAPI InterfaceModel baseURI "http://localhost:8080"

secured by

QueryStringKeyAuth

auth.OAuth2

authorized for scopes

admin, manager

collectionResource TaxFilingCollection type TaxFiling

...

collectionResource PersonCollection type Person

...

objectResource TaxFilingObject type TaxFiling

...

objectResource PersonObject type Person

...

objectResource Addressbject type Address

...

Parameters

Field Name

Type

Description

<resource-api-name>

Name

The Name assigned to this Resource API.

<uri>

URI

The base URI of the resources defined in this Resource API which themselves declare URIs relative to this.

Child Elements

Name

Topic

Description

<secured>

Secured

Applies a Security Scheme

to the Resource API.

<collection-resource>

Collection Resource

Defines a resource representing a collection of objects.

<object-resource>

Object Resource

Defines a resource representing a single object.

Parent Elements

RAPID Model

Created with Help & Manual 6 and styled with Premium Pack Version 2.51 © by EC Software