API Athens Meetup - API standards 25-6-2014
Download as PPTX, PDF6 likes3,441 views
The document discusses different API description formats including API Blueprint, RAML, and Swagger. It provides an overview of each format's key features such as how they model REST, available tooling, community size, and licensing. The conclusion is that while Swagger has the largest adoption, both RAML and API Blueprint offer some advanced features but lack tooling and community. The best choice depends on needs and technologies. Examples of other formats like WADL, Discovery Docs, and Hydra are also briefly mentioned.
API Athens Meetup - API standards 25-6-2014
- 6. 958 million websites 60 trillion web pages
- 7. Each API is Unique
- 10. The Answer
- 12. Narrowing down the choices API-Blueprint RAML Swagger What about Hypermedia? ioDocs? WADL? WSDL 2.0?
- 13. So now we want to know… What’s behind the name? How does it model REST? What tools are available? Is there a community / following? What’s it gonna be?
- 14. What’s behind the name? API-Blueprint RAML Swagger Format Markdown YAML JSON Spec License MIT ASL 2.0 / TM ASL 2.0 Available at GitHub GitHub GitHub Sponsored by Apiary Mulesoft Reverb Current Version 1A3 0.8 1.2 Initial commit April, 2013 Sep, 2013 July, 2011 Commercial Offering Yes Yes No API Design Approach Top-down Top-down Bottom-up
- 15. How does it model REST? API-Blueprint RAML Swagger Resources X X X (“api”) Methods/Actions X (“action”) X (“method”) X (“operation”) Query Parameters X X X Path/URL Parameters X X X Header Parameters X X X Representations (status codes, mime-types) X X X Documentation X X X
- 16. How does it model REST – part 2 API-Blueprint RAML Swagger Authentication Basic, Digest, Oauth 1&2, (*) Basic, API-Key, OAuth 2 Representation Metadata <any> (inline) <any> (inline/external) JSON Schema (subset) Nested Resources X X Composition/Inheritance Resource Models Traits, Resource Types File inclusions X API Version metadata X X Sample Representations X X
- 17. What about tooling? API-Blueprint RAML Swagger Authoring apiary.io API-Designer (3rd party) Ad-hoc testing apiary.io API-Console Swagger-UI Documentation X X X Mocking X X (3rd party) Server Code (3rd party) java java,scala,ruby, node.js Client Code (3rd party) java,groovy,scala,objc,andr oid,c#,flash,php,python,rub y,js Generate from code java, 3rd party (go,python) Validation X X (java) X Parsing C++ (nodejs, c#) Java, js Java, js
- 18. Some Community Stats API-Blueprint RAML Swagger Stackoverflow questions 37 18 596 Most Github Stars (on single project) 613 478 1859 Total Github projects (search on name) 72 52 340 Google search (name + “ rest”) 807K 64K 5M
- 19. So what gives!? Swagger: Pros: high adoption rate, good code-level tooling, large community Cons: bottom-up, lacks advanced metadata constructs RAML Pros: good online design tools and mature supporting infrastructure, seemingly useful advanced constructs Cons: very new to the game, low adoption, lacks code-level tooling API-Blueprint Pros: good online design tools, good community involvement Cons: new to the game, low adoption, lacks advanced constructs and code level tooling
- 20. How decide? What do your API consumers need/expect? Documentation Client code / SDKs / etc Technologies What do you need? Approach Tooling Technologies Do you need API management? Commercial Support?
- 21. Examples
- 22. WADL
- 23. Reverb Swagger
- 24. Mashery IOdocs
- 26. Apiary Blueprint
- 27. RAML
- 29. Automated API Provisioning Problem: How do I use an API without specifically coding for it? Answer: Use vocabulary to define operations on classes and properties Proposition: Annotations are the result of operations on entities or the relationships between entities. Those results are also entities, which may be operated upon.
- 30. Links and Operations Define operations on entities, types of entities, or their properties. When does a property link to an entity? How do you use pagination to reference and collect linked entities? What operations can I perform on an entity, or property of that entity? Where does authentication/authorization intersect with generic API interactions?
- 31. What is Hydra? W3C Community Group for Linked APIs REST + Linked Data “At the intersection of web schemas and RESTful web applications”
- 33. Keep in touch! Me Github mpetyx/ Twitter @mpetyx Mail [email protected] OPENi GitHub OPENi-ict/ Twitter @openi_ict Site http://www.openi-ict.eu/ Acknowledgments. This work has been created in the context of the EU-funded project OPENi (Open-Source, Web-Based, Framework for Integrating Applications with Social Media Services and Personal Cloudlets), Contract No: FP7-ICT-317883.
Editor's Notes
- #7: Και μονο που αλλαζει η ημερομηνια σε καθε ενα απο αυτα, καθε μερα αυτος ο αριθμος πολλαπλασιαζεται