Download as PDF, PPTX
Uploaded byJuan Victor Minaya León
GraphQL or RESTful
The document discusses RESTful APIs and GraphQL. It notes criticisms of RESTful APIs like requiring multiple requests to fetch related data and being rigid. GraphQL is presented as an alternative with features like strong typing and fetching related data in one request. The document also discusses evolving APIs through use of hypermedia, shared vocabularies, and adhering to REST principles like using nouns for resources and HTTP verbs for actions. Evolvable APIs are said to use these techniques to avoid breaking changes.
More Related Content
GraphQL or RESTful
- 1. GraphQL / RESTful Thedead RESTful API && Approach to Hypermedia minayaleon@gmail.com
- 2. RESTful is dead? ifgoogle says it then it is true. or not? minayaleon@gmail.com
- 3. Why? • Requires manyrequests to obtain the necessary data in a view of our application • If the endpoint changes then the clients fall • The error codes 2XX, 3XX, 4XX or 5XX are not used • It does not have a formalized type system losing the power of tools like Swagger to document • REST is very old minayaleon@gmail.com
- 4. GraphQL • It wascreated by Facebook • Is a query language for APIs and for executing queries by using a type system you define for your data • Use a strong typing system • It isn't tied to any specific database or storage engine and is instead backed by your existing code and data. minayaleon@gmail.com
- 5. Wait, I havea gift minayaleon@gmail.com
- 6.
- 7.
- 8. Know your needs minayaleon@gmail.com 12 Requirements Tools
- 9. Conclusions I • Knowyour needs • Know the tools • Choose the best tool, choose it yourself • No more “X is dead” minayaleon@gmail.com
- 10. 2018A look atthe current state of the APIs && Web minayaleon@gmail.com
- 11. Contracts minayaleon@gmail.com https://api.lifetap.com - Native AppLifetap - Web Lifetap
- 12. But… • Change theendpoint • Add new input parameters in the endpoints • We launch a new version • http://api.lifetap.com/v1, http://api.lifetap.com/v2 • More and more features minayaleon@gmail.com
- 13.
- 14. What should wedo?... minayaleon@gmail.com And when can not?
- 15. Conclusions II • Wehave forgotten the most important features of the web: Evolution • The web has survived more than 30 years • We must create Evolvable APIs minayaleon@gmail.com
- 16. How to createAPIs designed to evolve? minayaleon@gmail.com
- 17. RESTful Foundation REST Shared Vocabularies Hypermedia Evolvable APIs minayaleon@gmail.com TheGlory of REST Martin Fowler
- 18. Hypermedia But, it isnot new minayaleon@gmail.com
- 19. Your project useshypermedia • But it is very limited minayaleon@gmail.com
- 20. Hypermedia - Controls Home •One single URL (Home) • The APIs are navigable Types of controls • How does an application navigate? • IANA define 80 types of links • We can create more types minayaleon@gmail.com
- 21.
- 22. Hypermedia http://api.lifetap.com The clients nowcan navigate they don't need to know others URLs HATEOAS minayaleon@gmail.com
- 23.
- 24.
- 25. Hypermedia – Actions minayaleon@gmail.com Siren Specificationfor representing entities
- 26. Shared Vocabularies it isnot new, either minayaleon@gmail.com
- 27. Shared Vocabularies • Typesand Properties • screma.org has defined 600 types and 870 properties. • We can create more types and properties • The data models should not be exposed, they must be normalized. • The clients should know the types and properties minayaleon@gmail.com
- 28.
- 29. Shared Vocabularies (Swagger& OpenAPI) minayaleon@gmail.com
- 30. Use Case: ConvertMOV to MP4 API 192.168.5.67 Process 195.168.5.56 • Request • Queries • CRUD • and more… • Jobs • Sync DB • Video Convert • CDN https://proc.lifetap.com/upload-videohttps://api.lifetap.com/upload-video SSH 1 2 minayaleon@gmail.com
- 31.
- 32.
- 33. Use nouns, noverbs. Resource Name • When we write code, we name the methods with verbs that describe their functionality. For example, get_users or getUsers. This is fine in the code. But it's also common in URLs and it's not a good practice • keep it simple • The important is focus on the nouns that describe each resource. Now, to operate on our resource we will use HTTP verbs. Relations • What happens when our resources are related? /getUsers, /getUserById, /createUser, /editUser /users, /users/:id, /products, /orders /orders/:id/products /projects/:id/segments/:id/qualifications minayaleon@gmail.com
- 34. Methods HTTP Verbs CRUDAction GET Read Use GET requests to retrieve resource representation/information only POST Create Use POST APIs to create new resources PUT Update/Replace Use PUT APIs to update existing resource PATCH Update/Modify HTTP PATCH requests are to make partial update on a resource DELETE Delete As the name applies, DELETE APIs are used to delete resources minayaleon@gmail.com
- 35. Errors Code Code Description 200OK 400 Bad Request 401 Unauthorized 404 Resource not found 500 Internal Server Error minayaleon@gmail.com
- 36. Sources • https://martinfowler.com/articles/richardsonMaturityModel.html • https://swagger.io/specification/ •https://www.iana.org/assignments/link-relations/link-relations.xhtml • https://schema.org • http://stateless.co/hal_specification.html • http://hyperschema.org/mediatypes/siren • https://apigility.org/documentation/api-primer/halprimer • https://platzi.com/blog/como-crear-apis/ minayaleon@gmail.com
- 37.