Blog SW9

Desenvolvimento Web e Híbrido na prática.
Tome um café, concentre-se, codifique. (งツ)ว

Ferramentas para teste de API REST | Série Top 5 | Swagger | SW9

Ferramentas para teste de API REST | Série Top 5 | Swagger | SW9

Olá a todos. Sejam bem vindos ao Canal e Blog SW9 (http://blog.sw9.com.br)

Dando continuidade à série sobre [Ferramentas para teste de API REST], chegou a vez de conhecermos a ferramenta Swagger.

Se você ainda não viu o primeiro Post-Vídeo da série intitulada [Ferramentas para teste de API REST | Série Top 5 | Introdução | SW9], eu recomendo que faça isso, pois neste Post-Vídeo de introdução eu apresento o objetivo desta série, a importância dos testes em APIs, abordagens de teste e a dinâmica da série.

[O que veremos neste Laboratório?]

Para este quinto e último laboratório vou apresentar os recursos da ferramenta Swagger.  Para atingirmos este objetivo usaremos a API Pública da categoria [Imagem] que servirá como alvo de nossos testes.

[Mais Sobre a Ferramenta Swagger]

O Swagger é uma das ferramentas mais populares do mundo. A ferramenta aborda todo o ciclo de vida de uma API, passando pelo design, build (transformar as definições em código – permitindo gerar código para mais de 40 diferentes linguagens), documentação, teste e deploy.

Faz parte do Swagger uma plataforma chamada swagger hub, que permite construir, colaborar, documentar e hospedar as APIs.

Esta plataforma possui 1 plano gratuito (com limitações) e 2 planos pagos.

Para criar suas APIs você pode usar tanto a plataforma, como também as ferramentas open source disponíveis, já que o framework swagger é suportado por uma série de ferramentas (todas gratuítas e disponíveis no github).

Mas neste laboratório iremos focar na utilização da ferramenta inspector, que permite realizar testes de forma simples e rápida.

[A API Pública PixaBay]

PixaBay é um dos maiores repositórios de imagens e vídeos de alta qualidade. É uma API Gratuita e a única exigência para usá-la é incluir uma referência ao Pixabay, em formato de link, no local onde os dados são retornados.

[Limitações]

Podemos realizar no máximo 5.000 solicitações por hora.

As urls das imagens e vídeos não devem ser usadas de forma permanente em suas aplicações. Para isso, é necessário baixar as imagens e vídeos localmente.

Se precisar de imagens em alta resolução, será necessário solicitar acesso completo na API.

Este pedido é feito a partir de um link disponível na própria documentação da API. Durante o pedido, será necessário justificar a necessidade de precisar obter as imagens em alta resolução e concordar com os termos e regras impostos pelo serviço.

[Controle de requisições]

A API PixaBay usa o mesmo formato adotado pela API microlink.

Para cada requisição, a API retornará no cabeçalho as seguintes informações:

X-RareLimit-Limit – número limite de requisições a cada 30 minutos

X-RateLimit-Remaining – quantidade de requisições disponíveis

X-RateLimit-Reset – tempo restante para reiniciar o contador

Com estas informações, poderemos controlar melhor o fluxo de requisições em nossa aplicação.

[Tratamento de Erros]

Caso ocorra algum problema, a API retornará um código de erro.

Exemplo: Se a taxa limite de requisições exceder, a API retornará o código 429 (“Too Many Requests”)

[Autorização]

O PixaBay utiliza uma API Key para autorizar as requisições. Para receber a sua API Key é necessário se cadastrar no PixaBay.

Após registro e ativação, a sua API Key estará visível na própria página de documentação da API.

[Quais operações iremos testar?]

A API possui apenas dois EndPoins. São eles:

Pesquisa por imagem: https://pixabay.com/api/

Pesquisa por vídeo: https://pixabay.com/api/videos/

Vou abordar aqui estes dois tipos de pesquisa, mostrando os parâmetros que podemos usar nas requisições e os dados retornados em cada requisição.

Bom pessoal, agora chegou o momento de assistirem o vídeo e aprender um pouco mais sobre a ferramenta Swagger e a API PixaBay.

Vou disponibilizar em minha área de downloads uma listagem com dezenas de APIS Públicas. Como faço para localizar esta listagem na área de Downloads? É bem simples. Após conseguir o acesso a área de downloads (instruções no final do Post), procurar pela pasta “/APIS PUBLICAS” e localizar o arquivo [Lista de APIs Publicas.txt].

Aprenda HTML 5 e CSS 3

Comece a criar Sites Com o Melhor do HTML 5 e CSS 3
Curso Relacionado

[Conclusão]

No Post de hoje [Ferramentas para Teste de API REST] apresentei a ferramenta Swagger e utilizei a API Pública Pixabay como alvo de nossos testes (processo de descoberta).

Bom, por hoje é só. Aproveitem o vídeo e bons estudos. Fiquem antenados, que em breve teremos mais novidades.

Bom divertimento :-)

Para baixar a lista de APIs públicas, basta clicar no link [Quero Ter Acesso a Área de Downloads], informar o seu melhor e-mail e automaticamente você terá acesso ilimitado na minha área de downloads. Dentro da minha área de downloads, procurar pela pasta “/APIS PUBLICAS” onde vai encontrar um arquivo no formato .txt

Espero que gostem deste vídeo. Aproveito para pedir a participação de vocês no canal e blog, curtindo, compartilhando, dando sua opinião e se inscrevendo no canal e blog para receber as novidades em primeira mão.

Fiquem com Deus e até o próximo vídeo.

[Links úteis]

Curso Relacionado: [Aprenda HTML 5 e CSS 3 e Comece a Criar Seus Próprios Sites] – https://goo.gl/QsLPph

Área de Downloads: http://blog.sw9.com.br/acesso-area-de-downloads/

API Pixabay: https://pixabay.com/api/docs/

Swagger: https://swagger.io/

Swagger inspector: https://swagger.io/swagger-inspector/

Meu Blog: http://blog.sw9.com.br

Meu GitHub: https://sw9brl.github.io/MyGitHubPage

Canal youtube: https://youtube.com/+sw9brl

Link do vídeo: https://youtu.be/du6xph9oxvE

Parceria: https://www.tubebuddy.com/pricing?a=sw9brl

✔ Clique em gostei ✔ Compartilhe ✔ Inscreva-se

Tópicos Relacionados

Deixe um comentário

Você pode usar estas tags e atributos de HTML: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <s> <strike> <strong>

Paulo Eduardo
Geek desde criança, sempre me interessei por games, filmes e tecnologia. Sou graduado em engenharia da computação pela PUC Campinas. Possuo mais de 15 anos de experiência em desenvolvimento, com foco maior em desenvolvimento web, gestão de times e mais recentemente desenvolvimento mobile utilizando HTML e Javascript.

Termos como #backend, #frontend e #fullstack fazem parte do meu dia a dia.

Não deixe de acompanhar meu blog, canal youtube e meus produtos digitais.

Divirta-se e bons estudos. :-)
Paulo Eduardo on sabyoutubePaulo Eduardo on sabinstagramPaulo Eduardo on sabgithubPaulo Eduardo on sabfacebook
✌(◕‿-)✌ Tempo Limitado - Tenha acesso a nossa área de DownloadsClique Aqui - É Grátis
How to whitelist website on AdBlocker?