Boas Práticas em APIs REST

slides para a apresentação sobre boas práticas em apis rest no papo reto da bluesoft

Transcript

1. boas práticas em Diogo Beato @dvbeato
2. REST - Representational State Transfer Desenvolvimento orientado a webservices Criado por Roy Fielding
3. Independência de tecnologia Flexibilidade para clientes diferentes Venda de serviços
4. urls amigáveis: acelerato.com/tickets simples e de fácil adoção flexível para quem for utilizar
5. Creates e Updates retornam o recurso NÃO utilize verbos para os recursos Utilize sempre nomes no plural Recursos Lógicos
6. GET /tickets GET /tickets/12 POST /tickets PUT /tickets/12 PATCH /tickets/12 DELETE /tickets/12 Recursos Lógicos
7. GET /tickets/12/messages GET /tickets/12/messages/5 POST /tickets/12/messages PUT /tickets/12/messages/5 PATCH /tickets/12/messages/5 DELETE /tickets/12/messages/5 Relacionamentos
8. A API é tão boa quanto sua documentação Cria independencia e autonomia Mesmo que seja uma API privada e interna Documentação
9. Mudanças são inevitáveis Sempre versione sua API GET /v1/tickets Versionamento
10. Utilize query parameters GET /tickets?state=open GET /tickets?sort=-priority,created_at Filtros e Ordenação
11. Para filtros comuns, crie alias GET /tickets/recently_closed Filtros e Ordenação
12. GET /tickets?fields=id,subject,customer_name Seleção de campos
13. GET /tickets?page=2&per_page=50 Paginação
14. Roy Fielding
 http://roy.gbiv.com/ Tese de Roy Fielding 
 http://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm Artigo
 http://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api REFERÊNCIAS