Презентация Антона Богдана "Our practice of designing and implementing REST-service API for existing system" с конференции Z-Tech 9.02.2013

2.  Anton Bogdan
◦ Architect in Softengi company
 (Kiev, Zhitomir, Kharkov)
 29 years old
 7 years of experience
◦ 5 years of one project
◦ 2 years as an architect
2

3.  Enterprise application for corporate
clients(100+)
 SaaS, access via browser (ASP.Net).
 Heaviest DB for single client - 70Gb (MS SQL)
 10+ years in production
 1M code-lines
 .Net
◦ ASP.Net, Remoting, WCF, WF
 MSSQL
◦ Service broker, AlwaysOn Failover Cluster
3

4. 4
Custom form
please!

5. 5
Web Services
AJAX
Static files
hosting
Static
Resources
.js
.html .CSS
Server-side
/apps/<app Id>/*
/api/*

6.  SOAP
 /Auth.asmx
 /Workflows.asmx
 /Tasks.asmx
 REST
 /sessions/
 /processes/workflows/
 /processes/tasks/
6

7.  REST – it’s not spec, it’s architectural style
◦ It’s an art!
 Leverage HTTP!
 URL, Headers, Mime, Accepts
 Human readable URLs, XML and JSON !
7

8.  /workflows/<Name>
◦ GET - Read
◦ PUT - Update
◦ DELETE - Delete
 /workflows/
◦ POST - Create
 201 (Created), Location:<new url>
8

9.  /workflows/<Name>
 MOVE
 Destination: <new url>
 COPY
 Destination: <new url>
 PATCH
 POST /workflows/<Name>/close
9

10.  GET /workflows/
 -> String[]
 GET /workflows/?created=<2007
 -> String[]
10

11. /sql?q=SELECT * FROM workflows WHERE
date < 2007
Parsing
Validating
Transforming
Paging
SELECT TOP 20
w.id, w.name, w.type, cfv.[Field1]
FROM workflows w
JOIN permissions p
ON p.objectId = w.id
JOIN customfieldvalue cfv
ON cfv.objectId = w.id AND cfv.name = “Field1”
WHERE date < 2007
AND p.userId= <userId>
11

12.  Less Db identifiers
 More names and URLs
 No .Net/Java specifics:
◦ type: “MyNamespace.Workflow”
 No complex inner structures
 URL for hierarchies
 WebDav - for file systems.
12

13.  400 – Bad request (ParseException, ValidationException)
 401 – Unauthorized (wrong Session ID)
 404 – Not Found (ObjectDoesNotExistException)
 409 – Conflict (ObjectAlreadyExistException)
 500 – Unexpected
 503 – Service Unavailable
13

14.  Authentication
 Session ID in header or cookies
 Response Caching
 Etags
 Throttling
 Versioning
 api/ver1/*
14

15.  sdk.js (require jquery.js json2.js)
 Javascript API:
◦ sdk.auth.authenticate(userName, password, onsuccess, onerror)
◦ sdk.auth.getInfo(onsuccess, onerror)
◦ sdk.auth.end(onsuccess, onerror)
◦ sdk.workflows.create(name, object, onsuccess, onerror)
◦ sdk.workflows.update(name, object, onsuccess, onerror)
◦ sdk.workflows.delete(name, onsuccess, onerror)
◦ …
15

16.  No Date type in JSON spec! - ISO Date
 DateTime TZ problems
 CORS (server-side + EasyXDM)
 HttpRequest: PATCH operation
 Files Download/Upload (+ progress)
16

17.  sdk.js+qunit.js+JsTestDriver+TeamCity
 DB setup-rollback problems
 JS async tests – new for our developers
17

18. 18
asyncTest("Delete workflow - Happy path", 1, function() {
var queue = new ActionQueue(this);
// Given
queue.enqueue(function() {
sdk.workflow.createWorkflow(”Wf1",
function(response) { queue.executeNext();}, errorHandler);
});
// When
queue.enqueue(function() {
sdk.workflow.deleteWorkflow(”Wf1",
function(response) {
// Then
equal(response.metadata.statusCode, 204, "Status code OK");
}, errorHandler);
});
queue.executeNext();
});

19. 19

20.  http://xpinjection.com/2012/06/14/rest-in-uadevclub-
july-5/
 http://video.yandex.ua/users/xpinjection/view/192/
 http://video.yandex.ua/users/xpinjection/view/193/
 http://video.yandex.ua/users/xpinjection/view/194/
 http://martinfowler.com/articles/richardsonMaturityModel
.html
 http://www.jopera.org/files/soa-amsterdam-restws-
pautasso-talk.pdf
 http://www.infoq.com/news/2008/05/rest-vs-ws-star
 http://www.iana.org/time-zones
 http://www.w3.org/TR/cors/
 Libs:
◦ http://easyxdm.net/wp/
◦ https://github.com/bigeasy/timezone
20