RESTful API - GDG Tech Talk - Novembro de 2014
•
9 likes•1,189 views
The document discusses best practices for designing RESTful APIs, including: - Resources should be nouns, not verbs, and be pluralized. Requests should use HTTP methods like GET, POST, PUT, DELETE. - Responses should include status codes to indicate success or errors. Common formats are JSON and XML. - APIs should have versioning, support filtering, pagination, and partial responses for performance. - HATEOAS principles encourage making the API self-documenting through returned links.
Recommended
Recommended
More Related Content
Similar to RESTful API - GDG Tech Talk - Novembro de 2014
Similar to RESTful API - GDG Tech Talk - Novembro de 2014 (20)
More from Marlon Carvalho
Recently uploaded
Recently uploaded (20)
RESTful API - GDG Tech Talk - Novembro de 2014
- 2. @marlonscarvalho marlon.carvalho.963 +MarlonCarvalho profile/view?id=113395968
- 3. pplication rogramming nterface A P I
- 7. XML-RPC DCOM SOAP RMI
- 11. R E S T
- 14. R E S T PRESENTATIONAL TATE RANSFER
- 15. NÃO É UM PADRÃO
- 16. NÃO É UM FRAMEWORK
- 19. Por que ser REST?
- 22. JSONVSXML
- 23. RECURSOS TUDO É UM RECURSO
- 24. SOAP OPERAÇÕES MÉTODOS PROCEDURES
- 32. PLURAL USE O PLURAL PARA REFERENCIAR RECURSOS
- 40. HTTP METHODS GET POST PUT DELETE PATCH OPTIONS HEAD http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html
- 42. NUNCA USE VERBOS NA URI …OU QUASE NUNCA…
- 45. [{ "id": 1234, "nome": "Delirium Tremens”, "tipo": { "id": 1, "nome": "Tripel" } }]
- 47. { "id": 1234, "nome": "Delirium Tremens”, "tipo": { "id": 1, "nome": "Tripel" } }
- 50. { "id": 1234, "nome": "Delirium Tremens”, "tipo": { "id": 1, "nome": "Tripel" } }
- 52. { "id": 1234, "nome": "Delirium Tremens”, "tipo": { "id": 1, "nome": "Tripel" } }
- 55. PATCH VS PUT
- 56. A new method is necessary to improve interoperability and prevent errors. The PUT method is already defined to overwrite a resource with a complete new body, and cannot be reused to do partial changes. http://www.ietf.org/rfc/rfc5789.txt
- 57. GET NUNCA ALTERA DADOS!
- 60. VERBOS DOIS CASOS ONDE ELES SÃO PERMITIDOS
- 62. PATCH POST GET PUT DELETE CREATE RETRIEVE UPDATE DELETE
- 63. PUT HTTPS://API.BEBUM.COM/CERVEJAS/1234 Não existe uma cerveja com ID=1234
- 64. "If the Request-URI refers to an already existing resource, the enclosed entity SHOULD be considered as a modified version of the one residing on the origin server. If the Request-URI does not point to an existing resource, and that URI is capable of being defined as a new resource by the requesting user agent, the origin server can create the resource with that URI. " http://www.w3.org/Protocols/rfc2616/rfc2616-sec9.html
- 65. 200 - 300 - 400 - 500 HTTP STATUS CODES http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
- 67. 200 OK 201 CREATED 202 ACCEPTED 204 NO CONTENT 206 PARTIAL CONTENT
- 68. GET HTTPS://API.BEBUM.COM/CERVEJAS 200 OK 206 PARTIAL RESPONSE
- 71. DELETEHTTPS://API.BEBUM.COM/CERVEJAS/1 204 NO CONTENT 200 OK
- 72. 301 MOVED PERM. 307 TEMP. REDIRECT
- 73. 422 UNPROCESSABLE ENTITY 401 UNAUTHORIZED 404 NOT FOUND 409 CONFLICT 429 TOO MANY REQS
- 74. POST HTTPS://API.BEBUM.COM/CERVEJAS 401 UNAUTHORIZED
- 75. DELETE HTTPS://API.BEBUM.COM/CERVEJAS/1 404 NOT FOUND
- 76. PUT HTTPS://API.BEBUM.COM/CERVEJAS/1 409 CONFLICT
- 77. POST HTTPS://API.BEBUM.COM/CERVEJAS 422 UNPROCESSABLE ENTITY
- 78. POST HTTPS://API.BEBUM.COM/CERVEJAS 400 BAD REQUEST
- 79. { codigo: 1, descricao: “Erro por falta de informações…”, url: “http://api.bebum.com/doc/erro/1", mensagem: “Este erro ocorreu porque…" }
- 81. 500 INTERNAL ERROR 501 NOT IMPLEMENT. 503 SRV. UNAVAILABLE
- 82. EVITE INVENTAR NOVOS Não crie novos status code. Já existem muitos e são suficientes!
- 83. VERSIONAMENTO TUDO EVOLUI. OU DEVERIA… http://stackoverflow.com/questions/389169/best-practices- for-api-versioning
- 88. CABEÇALHO EXISTENTE Accept: application/json; v1
- 89. EVITE Accept: application/json; v1.0.1
- 90. JSON XML PNG
- 94. GET Accept: application/json HTTPS://API.BEBUM.COM/CERVEJAS/1234
- 95. GET Accept: application/xml HTTPS://API.BEBUM.COM/CERVEJAS/1234
- 96. GET Accept: image/png HTTPS://API.BEBUM.COM/CERVEJAS/1234
- 97. POST Content-Type: application/json HTTPS://API.BEBUM.COM/CERVEJAS
- 98. POST Content-Type: application/xml HTTPS://API.BEBUM.COM/CERVEJAS
- 99. FILTROS E se quisermos cervejas com nome “Stella"?
- 102. PAGINAÇÃO E se houver muitas cervejas?
- 104. GET x-offset: 1 x-limit: 15 accept: application/json HTTPS://API.BEBUM.COM/CERVEJAS
- 105. REQUEST: GET Accept: application/json Range: entidade=1-10 HTTPS://API.BEBUM.COM/CERVEJAS RESPONSE: status: 206 ou 416 Content-Range: entidade=1-10/1000
- 106. http://stackoverflow.com/questions/924472/ paging-in-a-rest-collection https://devcenter.heroku.com/articles/ platform-api-reference
- 107. PARTIAL RESPONSES Preocupe-se com os dispositivos móveis http://yaoganglian.com/articles/partial-response/ http://googlecode.blogspot.ca/2010/03/making-apis-faster-introducing-partial. html
- 108. { "id": 1234, "campo1": "Teste", "campo2": { "id": 1, "nome": "Teste" }, "campo3": "Teste", "campo4": { "id": 1, "nome": "Teste" }, "campo5": "Teste", "campo6": { "id": 1, "nome": "Teste" }, "nome": "Teste", "campo7": { "id": 1, "nome": "Teste" }, "campo8": "Teste", "campo9": { "id": 1, "nome": "Teste" } } 500kb
- 109. { "id": 1234, "campo1": "Teste", "campo2": { 2kb "id": 1, "nome": "Teste" } }
- 111. GET HTTPS://API.BEBUM.COM/CERVEJAS?fields=id,nome Status Code: 206
- 114. SEGURANÇA Como tornar minha API segura?
- 117. HATEOAS Hypertext As The Engine Of Application State
- 120. { id: 1, nome: “Stella Artois” links: [{ href="http://api.bebum.com/cervejas/1", rel="self" },{ href="http://api.bebum.com/cervejas/1/comments", rel="comments" },{ href="http://api.bebum.com/cervejas/1", rel="like" }] }
- 121. HATEOAS A API diz o que você pode fazer com aquele recurso
- 124. { "id": 1234, "nome": "Delirium Tremens”, "links": { "link": { "rel": "like", "href": "https:…/1/like" } }
- 125. { "id": 1, "nome": "Pilsen”, "links": { "link": { "rel": "cervejas", "uri": "…/tipos/1/cervejas" } }
- 126. Livros Indicados: Artigos Indicados: http://www.infoq.com/br/articles/rest-introduction http://apigee.com/about/resources/ebooks/web-api-design http://sensedia.com/br/webinar-design-de-api-restful http://restcookbook.com/