Model Driven APIs using NoMagic MagicDraw & E2E Builder/Bridge

amkbcloud amkbcloud.com

Your Presentation Title

Goes Here Model Driven APIs

Cliff C Faurer

AMKB Cloud

amkbcloud.com Copyright © 2015 AMKB Cloud amkbcloud

Contents

• What is an API?

• What is a Web API?

• Who needs APIs?

• How can I create an API Spec?

– Forward engineering using model-driven approach

• Can I use MagicDraw & E2E to implement a REST JSON API?

• Summary



Goes Here What is an API?


Definition of API

http://sproutsocial.com/insights/what-is-an-api/


• Defined interfaces through which interactions happen between an enterprise and applications that use its assets

• API approach – architectural approach that revolves around providing programmable interfaces to a set of services to different applications serving different types of consumers

• “Web API" = Web Service – Recent trend (so-called Web 2.0) moving away from

Simple Object Access Protocol (SOAP) based web services and service-oriented architecture (SOA)

– Towards direct Representational State Transfer (REST) style web resources defined using JavaScript Object Notation (JSON) format and Resource-Oriented Architecture (ROA)

Definition of Web API

http://en.wikipedia.org/wiki/Application_programming_interface



Goes Here Who Needs APIs?


API Users

API Provider

View of an API Program

API Platform

Public

Partner

Internal

API Endpoints :

service provider

systems

Publishes APIs

on

RESTful JSON

APIs and/or

WSDL SOAP

APIs provide access to

services

© 2013 TM Forum | 8

V2013.5

85,000 PROFESSIONALS

900+ MEMBER COMPANIES

195 COUNTRIES

1 FORUM

TM Forum is the largest global trade association focused on bringing together the digital ecosystem, including communication service providers, digital service providers and enterprises, with the goal of enabling an open digital world. TM Forum members represent 85% of global communications revenue.

© 2013 TM Forum | 9

V2013.5

Frameworx Components

1. The Business Process

Framework – eTOM

2. The Information

Framework – SID

3. The Application

Framework – TAM

4. The Integration

Framework – Business

Services & APIs

Frameworx revisions are released twice a

year, currently on 15.0


What you pay

for.

What you pay

for. What you get!

Engaged Party

Domain

Frameworx Business Domains


Fx Information

Framework Fx Application

Framework

Integration

Framework

Copyright AMKB Cloud LLC 2015

Fx Integration

Framework

Fx Business

Metrics

Process

Framework

Fx Process

Framework

Business

TBD

Business

TBD

Business

TBD

Business

TBD

e.g. REST APIs

The Sweet Spot


AMKB Cloud Frameworx Models


TM Forum Frameworx Open Digital API Business Guide

Open Digital Business Scenarios and Use Cases

July 2014

APIs in a Typical Customer Journey


Detailed Interactions & APIs


Connected Car Interactions


On ‘commercial’ API Platform

On proprietary portal

With interactive

documentation

As a service – no user

interface

Design

Online documentation

Troubleshooting /

sandbox environment

Support desk

High level: What set

of APIs does the

business require?

Low level: API

descriptions

consumable by

software systems

API Lifecycle – API Provider View

Publish Support

Note: We are considering aspects of the lifecycle visible to the API program team & the API users

– not the API endpoint implementation. Also not considering security. This is usually handled by

API Platform.


Autocreated interactive

documentation with Swagger UI

Or easy integration to API

platform developer portals

Automated support

services : replacing

support desks

High level: leverage

TMF Frameworx

Low level:

MagicDraw models

and/or Swagger

Where Model Driven can Help

Rich diagnostics,

helping API users learn

Rapid prototyping for APIs with MagicDraw,

E2E, Swagger, and RuleX

Design Publish Support


Catalog of TM Forum REST APIs

• Billing Management

• Customer Management

• Party Management

• Performance Management

• Product Catalog Management

• Product Inventory Management

• Product Order Management

• SLA Management

• Ticket Management

• Usage Management

Additional APIs under specification:

• Service Catalog Management

• Service Inventory Management

• Service Order Management

• Resource Catalog Management

• Resource Inventory Management

• Resource Order Management

• MEF – Service Activation

Management

See https://www.amkbcloud.com/blog/ for more details

The 16 + 1 TM Forum Digital Service APIs

https://www.amkbcloud.com/blog/



Goes Here How can I create an API

Spec?


TM Forum Customer Management API*

Swagger UI

Send API

request

MagicDraw E2E

Server

Model Driven API – Example

API User

Receive

responses

Retrieve persisted

resources

State machine behavior

Persistence using SQLite

Returns RI responses

REST API

* We have prototyped all 16 + 1 TMForum REST APIs

Try the demo: https://www.amkbcloud.com/blog/?p=151

https://www.amkbcloud.com/blog/?p=151

https://www.amkbcloud.com/blog/?p=151


UML Model for

APIs

MagicDraw & E2E Builder/Bridge

Implemented for TMF – Billing, Customer, Party, Performance, Product Catalog, Product Order, Product

Inventory, Service Catalog, Service Order, Service Inventory, Resource Catalog, Resource Order, Resource

Inventory, Service Level Agreement, Ticket & Usage

MS Word Spec

MagicDraw

&

E2E Builder Swagger description

+ Swagger UI

Reference

Implementation

Can also add business rules on the APIs to the UML model, and generate into the specs, and the

ref implementation

E2E Bridge Server with

SQLite database


Customer Mgmt API - Customer


Customer Mgmt API – Customer Account


Customer Mgmt API – Payment Mean


Customer Mgmt API – REST Services


Generate Business Service Spec


Customer Mgmt API Spec Doc


Generate Swagger Spec


Generated swagger.json – Interface Specification


Swagger UI - Demo


Swagger UI – Payment Mean



Goes Here Can I use MagicDraw &

E2E to implement a

REST JSON API?


UML Model for

APIs


Implemented for TMF – Billing, Customer, Party, Performance, Product Catalog, Product Order, Product

Inventory, Service Catalog, Service Order, Service Inventory, Resource Catalog, Resource Order, Resource

Inventory, Service Level Agreement, Ticket & Usage

MS Word Spec

MagicDraw

&

E2E Builder Swagger description

+ Swagger UI

Reference

Implementation

Can also add rules on the APIs to the UML model, and generate into the specs, and the ref

implementation

E2E Bridge Server with

SQLite database


E2E Builder

Model of TMF

ODE Customer

Management

model compiled

into executable

REST API service

MagicDraw & E2E – Customer Mgmt REST API


REST POST Payment Mean


REST APIs Deployed to E2E Bridge


Swagger UI – POST Payment Mean


E2E Code

Generation

Swagger

Description

Prototype

REST API

MagicDraw as Super Enabler

xUML

MagicDraw

Model 100%

generated

100% generated

Swagger UI

100% generated

Manage multiple APIs

together - share ‘common

elements’ across APIs

Autogenerate

documentation

REST API

Documentation

Visual Model

Manage API structure and business

rules together

Guarantee generated Swagger is

correct & consistent

100% generated



Goes Here Summary


Find out more

Model Driven – Web Service REST API

Spec & Reference Implementation (RI)

Email cfaurer(at)amkbcloud.com

Visit amkbcloud.com


Model Driven APIs using NoMagic MagicDraw & E2E Builder/Bridge

Business

amkb cloud amkbcloud

api spec

rest json api

rest apis

forum tm forum

web services

application framework

information framework