1. Extensibility Guide
  2. Extensible Points in Service Tier
  3. REST Tier
  4. Guidelines

3.1.1 Guidelines

  • OBAPI REST tier follows façade pattern, meaning that it is just an endpoint built on top of application service(s).
  • A REST service should not have any business logic. It should consume one or more application services and prepare the response.
  • Before coding a new REST service, developer should decide the resource(s) and sub-resources(s) that s/he needs to develop. Based on this, the developer can design required URIs. E.g. A ‘Demand Deposit Account’ is a resource in the system and /accounts/demandDeposit/{accountId} is the REST URI to access it.
  • The service should be annotated suitably using JAX-RS annotations.
  • The service should wrap its operation in ‘Channel Interaction’.
  • The service should use adequate logging.

Parent topic: REST Tier