Api first desenhando e testando sua api like a boss

Renan Petronilho Sant Anna
renan.petronilho@sensedia.com
@renanpetronilho
Petterson Henrique Andrade
petterson.andrade@sensedia.com
@pett4j
Claudenir Freitas
claudenir.machado@sensedia.com
@claudenir_cf

Agenda
API First
Boas práticas
Testes

1-Your API is the first user interface of your application
https://medium.com/adobe-io/three-principles-of-api-first-design-fa6666d9f694
Compromisso com APIs
Anyone who doesn’t do this will be fired. Thank you; have a nice day!

2- Your API comes first, then the implementation

3- Your API is described (and maybe even self-descriptive)
● GET /podcasts- Retorna a lista de podcasts
● GET /podcasts/cbdf-34rf-ee3r4- Retorna o podcast com id
“cbdf-34rf-ee3r4”
● POST /podcasts- Cria um novo podcast
● PUT /podcasts/cbdf-34rf-ee3r4- Altera os dados de um podcast
● PATCH /podcasts/cbdf-34rf-ee3r4- Altera somente alguns
dados de um podcast
● DELETE /podcasts/cbdf-34rf-ee3r4- Remove um podcast

Top 5 motivos para o API First

Mobile First
https://soulfulhustle.com/mobile-first-vs-responsive/

Artificial Intelligence - AI First

Microservices Architecture
http://microservices.io/patterns/microservices.html

http://microservices.io/patterns/apigateway.html
API Gateway

“Vou criar o meu padrão que será melhor do que
REST com Restful.
Go Horse Bible - Capítulo 1, versículo 50

Criar meu protocolo ou usar padrões?

Common Description Language?
Padrões - Não reinvente a roda

Documentação

Portal de desenvolvedores

URI
Versão
URI: https://api.mycompany.com/name-of-api/v2/resource
HTTP ou
HTTPS
Seu domínio Nome da API
(opcional)
Recursos e
Parâmetros
Nunca quebre o cliente!!
Outras alternativas:
• Twilio: /2010-04-01/Accounts/
• Salesforce.com: /services/data/v40.0/limits

Recursos
Substantivos
Plural
Verbos
Coleção
/pedidos
Elemento
/pedidos/{id}
Sub-Elemento
/pedidos/{id}/itens/{id}
Sub-Coleção
/pedidos/{id}/itens

/getAccount
/getAllAccounts
/createDirectory
/updateGroupName
/findClientById
RPC?

GET POST PUT
DELETE PATCH OPTIONS
HEAD

HEADOPTIONSPATCHDELETEPUTPOSTGET
Método de Consulta
GET /pedidos
GET /pedidos/10
GET /pedidos/10/itens

Método para “Criação”
POST /clientes/98W353s1/enderecos
{
"endereco": "Av. Brigadeiro Faria Lima",
"numero": "3800",
"complemento": "18o. Andar",
"bairro": "Itaim Bibi",
"cidade": "São Paulo",
"estado": "SP",
"cep": "04538-132"
}

Método para “Atualização”
PUT /clientes/98W353s1/enderecos/1
{
"endereco": "Av. Brigadeiro Faria Lima",
"numero": "2000",
"complemento": "18o. Andar",
"bairro": "Itaim Bibi",
"cidade": "São Paulo",
"estado": "SP",
"cep": "04538-132"
}

Método para Remoção
DELETE /pedidos/98w351
DELETE /users/562w3/photos

Método para atualização parcial
PATCH /pedidos/98w351
PATCH /users/562w3
{
"status": "cancelado"
}
{
"email": "renan.petronilho@sensedia.com"
}

Quais métodos são permitidos?
OPTIONS /clientes
Allow: HEAD, GET, POST, OPTIONS

Quero ver apenas o Header
HEAD /clientes
Date: 03-08-2017
Content-Type: application/json
Content-Length: 1024

● 200 - OK
● 201 - Criado
● 202 - Aceito
● 204 - Sem Conteúdo
Resultado OK
● 400 - Erro no Cliente
● 404 - Não encontrado
● 413 - Request muito
grande
● 429 - Muitas requisições
Erro no Cliente
● 500 - Erro no Servidor
● 503 - Serviço indisponível
● 504 - Gateway Time-Out
Erro no Servidor
https://httpstatuses.com/ http://www.restapitutorial.com/httpstatuscodes.html

500400200
GET /candidatos?estado=SP&partido=PP
[
{
"id": "1532962",
"apelido": "PAULO MALUF",
"nome": "PAULO SALIM MALUF",
"numero": "1111",
"cargo": "Deputado Federal",
"estado": "SP",
"partido": "PP",
"reeleicao": true
}
]
Status & Error Codes
200 OK

500400200
POST /items/1234/bids
{
"amount" : 602.99
}
201 Created
201 Created
Location: /items/1234/bids/100001
{
"amount" : 602.99,
"current_bid" : 510,
"winning" : true
}

500400200
202 ACCEPTED
POST /items/1234/bids
{
"amount" : 602.99
}

500400200
DELETE /items/1234
204 Deleted
Retorno vazio

500400200
GET /candidatos
400 Requisição inválida
400 Requisição inválida
{
"status" : 400,
"code" : 40377,
"message" : "Parâmetro 'estado' não pode ser nulo
ou vazio"
"more" : https://dev.empresa.com/errors/40377
}

500400200
Outros erros comuns
Não autorizado
Proibido
Não encontrado
401
403
404
Entidade de solicitação muito grande
Entidade improcessável
Muitas requisições
413
422
429

500400200
PUT /pedidos/995620
500 Erro interno do servidor
{
"status" : “CANCELED”
}
500 Internal Server Error
{
"status" : 500,
"message" : “Ops, algo saiu errado”
}

Filtro
GET /produtos/search?q=macbook
Busca global
GET /pedidos?status=concluido
Busca com escopo(subconjuntos)
GET /pedidos/12AF?_fields=numero,data,valor
Respostas parciais

Paginação
GET /produtos?_offset=50&_limit=25
Recomendação
Linkedin ?start=50&count=25
Outras opções
Instagram ?min_id=3091&max_id=3120&count=25

Hypermedia
*POX = Plain Old XML, Richardson Maturity Model http://martinfowler.com/articles/richardsonMaturityModel.html
HATEOAS
Hypermedia As The Engine Of Application State

COM HypermediaSEM Hypermedia
{
"results": [
{
"id": 123,
"name": "Macbook Air 2014 LIKE NEW",
"price": "1120"
}
]
}

COM HypermediaSEM Hypermedia
{
"results": [
{
"_links": [
{"rel": "self","uri": "/items/123"},
{"rel": "bids","uri": "/items/123/bids"},
{"rel": "win","uri": "/items/123/bids?q=win"}
],
"name": "Macbook Air 2014 LIKE NEW",
"price": "1120"
}
]
}

Técnicas de Testes
- Teste estrutural
- Nível de código
Caixa Branca
- Teste funcional
- Nível de negócio
Caixa Preta

Testes
Mike Cohn, Succeeding with Agile.

Testes
Tipos de testes
Teste de unitário

Testes
Tipos de testes
Teste de contrato
Teste de integração
Teste de regressão
Teste de stress

Testes
Tipos de testes
Testes funcionais
Testes de aceitação

Talk is cheap. Show me code!
Linus Torvalds

Api first desenhando e testando sua api like a boss

Recomendados

Recomendados

Mais conteúdo relacionado

Semelhante a Api first desenhando e testando sua api like a boss

Semelhante a Api first desenhando e testando sua api like a boss (20)

Api first desenhando e testando sua api like a boss