RESTful API Design Model

The RESTful API Design Model (RADM) is a new UML model in the IBM Banking Process and Service Models (BPS) RSA project that enables a model-driven development approach for the specification of Banking REST APIs.

Key features of RADM:

• Enables the development of consumable Banking APIs with:

  • Consistent resource names
  • Common query parameters
  • Simple JSON/XML data structures that:
    • Are not deeply nested
    • Do not use polymorphism
• RADM elements are derived from the Interface Design Model (IDM) per the other platform-specific BPS service design models
• Boundary Of Type (BOT) diagrams added to BOM and IDM to help design REST Data Objects (RDO).
• API documentation and specifications (WADL and Swagger) can be generated from RADM
• API implementation code can be generated from RADM
• Banking APIs created from RADM:
  • Hide the underlying complexity of IBM Banking Process and Service Models
  • Can easily be used by app developers without knowledge of IBM Banking Process and Service Models
• Conforms to IBM API best practices