Alfresco Day Vienna 2015 - Technical Track - REST API of the Future
2 likes1,068 views
Alfresco Day Vienna 2015 - Technical Track - REST API of the Future - Gavin Cornwell, Engineering Manager, Alfresco
Ad
More Related Content
What's hot (20)
Similar to Alfresco Day Vienna 2015 - Technical Track - REST API of the Future (20)
Ad
More from Alfresco Software (20)
Ad
Recently uploaded (20)
Alfresco Day Vienna 2015 - Technical Track - REST API of the Future
- 1. REST API of the Future 1st December 2015 Gavin Cornwell (@gcornwell), Engineering Manager
- 2. Agenda • Introduction • Past • Present • Future • Demo • Questions Agenda
- 3. Introduction
- 4. Why? • REST API space moving at an incredible rate, lots of stories every week • Surge in mobile devices drove API usage • Twitter have billions of API calls per day! • Everything has an API – Apps, IoT, SmartTVs, Cars! • “X”aaS • Main entry point is REST API • Extension point; no in-process access • Treated as a product not a feature Introduction
- 5. Community • Open API Initiative (OAI) – Google, Microsoft, IBM, 3Scale, Apigee, Restlet et al. – Linux Foundation – https://openapis.org – Swagger -> Open API Definition Format (OADF) • Open APIs – http://apicommons.org (metadata/patterns) – http://apis.io (registry) • Open Data – Even Government data Introduction
- 6. Tooling • Lots of tools emerging (new one every week) • Numerous REST clients • Amazon API Gateway • SwaggerHub • Restlet APISpark • Can do some really cool stuff! • http://restlet.com/blog/2015/10/28/real-time-stock-quotes- from-google-finance-with-apispark/ Introduction
- 7. Past
- 8. Past • Web Services (SOAP/WSDL) • CMIS • Webscript framework introduced • REST APIs started emerging • Organically grew • Inconsistent URLs, parameters & responses (JSON & XML) • What’s public, what’s private? • Not very RESTful Past
- 9. Present
- 10. Present • Public API Framework (4.2) • Built on top of webscript engine • Set of internal RESTful guidelines • Consistent URLs, parameters & responses • Proper use of HTTP status codes • On-Premise and Cloud support • /alfresco/api/-default-/public/alfresco/versions/1 • Ticket and Basic Auth • api.alfresco.com/{network}/public/alfresco/versions/1 • OAuth only Present
- 11. URL Structure …/-default-/public/alfresco/versions/1/sites/{id}/members Present Scope API Name Version Entity RelationshipTenant
- 12. URL Examples • …/-default-/public/alfresco/versions/1/sites • …/-default-/public/workflow/versions/1/processes • …/-default-/public/cmis/versions/1.1/atom • …/-default-/private/alfresco/versions/1/cmm • …/-default-/extension/my-company/versions/1/my-entity Present
- 13. Entities • Nodes • Sites • People • Tags • Workflow • Networks (Cloud) Present
- 14. Confusion • REST API; which one? – /service/api – CMIS – Alfresco One API • Anyone know what this is? • 5.1 addressing this – v0 REST API – v1 REST API – CMIS API Present
- 15. 5.1 Enhancements • Stronger, clearer API support policy • v0 REST API moved to limited support • Backwards Compatibility Kit (BCK) • Documentation overhaul • http://docs.alfresco.com/5.1/concepts/welcome.html (EA) • More details from Ole later Present
- 16. Future
- 17. The following slides show roadmap information, it is not a commitment to implement those features and the information presented is subject to change. Future
- 18. Working On Now • v1 API investment • Node Entity (File/Folder) (Demo shortly) • Discoverability • Enhancing REST API framework • API Definition (think WSDL) • Swagger (Demo shortly) • API Explorer – Swagger UI initially Future
- 19. Future Considerations • Functional equivalence to v0 REST API • Client Libraries • Mobile (Android & iOS) already available • Java, JavaScript • Others generated from API definition • Contract-first design – Developers and technical authors – Generate boiler plate code for server & client – Community via pull requests Future
- 20. Future Considerations • Monitor standards – HATEOAS • Hypermedia As The Engine Of Application State • Roy Fielding; Level 3 • HAL, Siren, JSON-LD, Collection+JSON etc. • CMIS Atom; kind of! – OAI (Swagger/OADF) – RAML, API Blueprint – oData • Webhooks • Web Sockets Future
- 21. Future Considerations • Tooling (Lifecycle Management) • Design • Deploy • Keys/Authentication • Metrics • Monitoring • Integration with 3rd party tools Future
- 22. Demo
- 23. Demo • CMIS vs File/Folder API – Payload difference, size & speed • Swagger Definition & UI Demo
- 25. Questions?