Downloaded 237 times
Uploaded byUri Sarid
RAML - APIs By Design
The document discusses the importance of APIs in modern software development, particularly emphasizing the API economy and the need for effective API design. It introduces RAML (RESTful API Modeling Language) as a structured and human-readable approach to API development, advocating for clear documentation and user engagement. The text calls for open-source tooling and a collaborative approach to evolve the RAML specification and enhance API functionality.
More Related Content
![API design concepts [Intro]](https://cdn.slidesharecdn.com/ss_thumbnails/restfulapidesign-converted-201003085724-thumbnail.jpg?width=640&height=640&fit=bounds)
Similar to RAML - APIs By Design
RAML - APIs By Design
- 1. RAML – APIsBy Design #RAML Uri Sarid CTO, MuleSoft @MuleSoft @usarid
- 2.
- 3. Ultimate Buzz forCreatively-lazy Developers build on someone else's work… who's? 14000 12000 open APIs 10000 8000 6000 4000 2000 0 2005 2006 2007 2008 2009 2010 2011 2012 Source: 2013
- 4. Modularity, Encapsulation, Specialization yes,even Service-Oriented Architecture! eCommerce products shopping cart checkout billing shipping social graph posting geolocation city data weather attractions businesses collaboration documents notifications forums analytics traffic logs NLP sales marketing demographics SFA social
- 5. The API EconomyIs Big and It's Now >13,000 Open APIs Enterprise APIs 1,000,000s
- 6.
- 7.
- 8. The API ContractIs Critical • tells consumer devs what they'll get • tells implementer devs what to deliver • enables parallel development • ensures they'll meet in the end
- 9. My Experience: Barnes& Noble / the layer cake of APIs Don't expose dirty laundry users products orders invoices
- 10.
- 11. The traditional enterprise sitscomfortably behind the firewall Packaged apps Custom apps The Traditional Enterprise Databases
- 12. Welcome to theNew Enterprise SaaS Social Cloud platforms Mobility and Devices Customers / Partners / Suppliers Packaged apps Custom apps The New Enterprise Databases
- 13. Connect backend SaaS Social Cloud platforms Mobilityand Devices Customers / Partners / Suppliers Packaged apps Custom apps The New Enterprise Databases
- 14. Backend to SaaS SaaS Social Cloudplatforms Mobility and Devices Customers / Partners / Suppliers Packaged apps Custom apps The New Enterprise Databases
- 15. Everything needs toconnect SaaS Social Cloud platforms Mobility and Devices Customers / Partners / Suppliers Packaged apps Custom apps The New Enterprise Databases
- 16. The Anypoint Platform: integrationon-premises and cloud SaaS Cloud platforms Social Anypoint Platform Mobility and Devices Customers / Partners / Suppliers Mule Studio Anypoint Connectors Anypoint DataMapper Enterprise Mgmt DataSense Packaged apps Business Insight Custom apps Big Databases / Big Files
- 17. The Anypoint Platform: integrationon-premises and cloud 1,000s 100s SaaS 1,000,000s Cloud platforms 100,000s Social 1,000,000,000s Anypoint Platform Mobility and Devices Customers / Partners / Suppliers Mule Studio Anypoint Connectors Anypoint DataMapper Enterprise Mgmt DataSense Packaged apps Business Insight Custom apps Big Databases / Big Files
- 18. The Anypoint Platformfor APIs SaaS Cloud platforms Social Anypoint Platform Design/Dev Portal API Manager APIkit Anypoint Connectors Mobility and Devices API Gateway Studio Customers / Partners / Suppliers Anypoint DataMapper Business Insight Enterprise Mgmt DataSense Packaged apps Custom apps Big Databases / Big Files
- 19. An Opinionated Approachto API Success
- 20. The Key toAPI Success? how? • • • • design for them iterate quickly model cleanly and consistently engage
- 21. Design For YourUsers UI UX Capture Feedback API APX
- 22. Focus on theInterface: The Contract where consumers touch you your front door, your lobby, your façade how you want to be seen; your brand versioned more carefully than code better interfaces better code an organizing principle; alignment forcing function the ultimate testing surface
- 23. What kind ofinterface do we want? 1. Describe APIs simply and clearly 2. Design APIs easily and soundly 3. Engage users in compelling ways
- 24. Practically-RESTful APIs • • • • • • nouns: resources,described by URI paths verbs: HTTP methods metadata: HTTP headers responses: HTTP status codes representations: appropriate media types in the body use hypermedia – not necessarily, not yet
- 25. What Do PeopleDo Today?
- 26.
- 27.
- 28.
- 29.
- 30.
- 31.
- 32.
- 33. No Need toStart From Scratch! • • • • • • • well-known superset of JSON optimized for human readability great for hierarchies cruft-free broad tooling base extensible-ish broad tooling base
- 34. Introducing: RAML RESTful APIModeling Language A new open spec for RESTful APIs that's as clean and as structured as REST itself the RAML Workgroup: raml.org
- 35. RAML: How Clean?How Structured? Take what you would have typed yourself… /users: get: description: post: description: /users/{userId}: get: description: put: description: delete: description: Get a collection of users Create a new user in the collection Get a single user Update a single user Delete a single user
- 36. RAML: How Clean?How Structured?
- 37. RAML: How Clean?How Structured?
- 38. RAML: How Clean?How Structured? resource type schema trait
- 39. Covers Full HTTP optionalversion in baseUri template URIs query parameters headers (on request and response) response per status code example (and schema) per media type
- 40. Patterns: Resource Types externalizable inheritance pullin traits parametrize
- 41.
- 42. Patterns: body schemas XMLschema JSON schema or just use good ol' form data: examples
- 43. RAML for Real-TimeAPX Design
- 44.
- 45. What's next? open-sourcetooling; host it too (e.g. on APIhub) growing library of API specs in RAML (e.g. on APIhub) converters client generators server frameworks (e.g. MuleSoft APIkit; node.js) testing frameworks mocking services (e.g. on APIhub) <insert your ideas here> evolve RAML spec (RAML workgroup)
- 46.