SWAGGER
Documentando APIs desde
tempos imemoriais
A documentação de serviços GERALMENTE é um tédio
3
O que é swagger?
• Uma interface ao serviço.
• É um contrato para o teu serviço.
• É uma forma de descrever uma API.
4
Objetivo
• Estabelecer uma interface para APIs Rest
independeente da linguagem.
• Que permita aos seres humanos e comput...
5
Para que serve?
• Documentação interativa.
• Descrição de todo o que o server
pode fazer.
• Criar contratos.
• Interagir...
6
Swagger UI
7
Editor Swagger
8
Antepassados
• CORBA
• WSDL
• WADL
9
Outras ferramentas atuais
• RAML
• API Blueprint
• entre outros...
10
Comparação
11
Comparação
RAML SWAGGER API BLUEPRINT
Escrever YAML JSON/YAML Markdown
Ferramenta de
edição
Designer de API Editor Swag...
12
Comparação
13
Swagger no Tech Radar
14
Links
• http://www.slideshare.net/fehguy/swagger-foryourapi
• http://www.slideshare.net/fehguy/introducing-swagger
• ht...
Obrigado!
Duvidas, sugestões, feedback
Nicolás Agustín Torres
nagustin@thoughtworks.com
Próximos SlideShares
Carregando em…5
×

Swagger Lightning talk

298 visualizações

Publicada em

Short lightning talk about swagger

Publicada em: Software
0 comentários
0 gostaram
Estatísticas
Notas
  • Seja o primeiro a comentar

  • Seja a primeira pessoa a gostar disto

Sem downloads
Visualizações
Visualizações totais
298
No SlideShare
0
A partir de incorporações
0
Número de incorporações
4
Ações
Compartilhamentos
0
Downloads
3
Comentários
0
Gostaram
0
Incorporações 0
Nenhuma incorporação

Nenhuma nota no slide
  • sem acesso ao código fonte, documentação, ou rede inspeção de tráfego-through.
    Quando adequadamente definido via Swagger, um consumidor pode compreender e interagir com o serviço remoto com uma quantidade mínima de lógica de implementação.
  • sem acesso ao código fonte, documentação, ou rede inspeção de tráfego-through.
    Quando adequadamente definido via Swagger, um consumidor pode compreender e interagir com o serviço remoto com uma quantidade mínima de lógica de implementação.
  • sem acesso ao código fonte, documentação, ou rede inspeção de tráfego-through.
    Quando adequadamente definido via Swagger, um consumidor pode compreender e interagir com o serviço remoto com uma quantidade mínima de lógica de implementação.
  • sem acesso ao código fonte, documentação, ou rede inspeção de tráfego-through.
    Quando adequadamente definido via Swagger, um consumidor pode compreender e interagir com o serviço remoto com uma quantidade mínima de lógica de implementação.
  • sem acesso ao código fonte, documentação, ou rede inspeção de tráfego-through.
    Quando adequadamente definido via Swagger, um consumidor pode compreender e interagir com o serviço remoto com uma quantidade mínima de lógica de implementação.
  • Sem entrar em uma longa história de interfaces para Web Services, esta não é a primeira tentativa de fazê-lo. Podemos aprender com CORBA, WSDL e WADL. Estas especificações tinha boas intenções, mas foram limitados pelas implementações específicas de fornecedor de propriedade, estar vinculado a uma linguagem de programação específica, e as metas que foram muito aberto. No fim das contas, eles não conseguiram ganhar força.
  • Sem entrar em uma longa história de interfaces para Web Services, esta não é a primeira tentativa de fazê-lo. Podemos aprender com CORBA, WSDL e WADL. Estas especificações tinha boas intenções, mas foram limitados pelas implementações específicas de fornecedor de propriedade, estar vinculado a uma linguagem de programação específica, e as metas que foram muito aberto. No fim das contas, eles não conseguiram ganhar força.
  • Sem entrar em uma longa história de interfaces para Web Services, esta não é a primeira tentativa de fazê-lo. Podemos aprender com CORBA, WSDL e WADL. Estas especificações tinha boas intenções, mas foram limitados pelas implementações específicas de fornecedor de propriedade, estar vinculado a uma linguagem de programação específica, e as metas que foram muito aberto. No fim das contas, eles não conseguiram ganhar força.
  • Sem entrar em uma longa história de interfaces para Web Services, esta não é a primeira tentativa de fazê-lo. Podemos aprender com CORBA, WSDL e WADL. Estas especificações tinha boas intenções, mas foram limitados pelas implementações específicas de fornecedor de propriedade, estar vinculado a uma linguagem de programação específica, e as metas que foram muito aberto. No fim das contas, eles não conseguiram ganhar força.
  • Sem entrar em uma longa história de interfaces para Web Services, esta não é a primeira tentativa de fazê-lo. Podemos aprender com CORBA, WSDL e WADL. Estas especificações tinha boas intenções, mas foram limitados pelas implementações específicas de fornecedor de propriedade, estar vinculado a uma linguagem de programação específica, e as metas que foram muito aberto. No fim das contas, eles não conseguiram ganhar força.
  • Sem entrar em uma longa história de interfaces para Web Services, esta não é a primeira tentativa de fazê-lo. Podemos aprender com CORBA, WSDL e WADL. Estas especificações tinha boas intenções, mas foram limitados pelas implementações específicas de fornecedor de propriedade, estar vinculado a uma linguagem de programação específica, e as metas que foram muito aberto. No fim das contas, eles não conseguiram ganhar força.
  • Sem entrar em uma longa história de interfaces para Web Services, esta não é a primeira tentativa de fazê-lo. Podemos aprender com CORBA, WSDL e WADL. Estas especificações tinha boas intenções, mas foram limitados pelas implementações específicas de fornecedor de propriedade, estar vinculado a uma linguagem de programação específica, e as metas que foram muito aberto. No fim das contas, eles não conseguiram ganhar força.
  • Swagger Lightning talk

    1. 1. SWAGGER Documentando APIs desde tempos imemoriais
    2. 2. A documentação de serviços GERALMENTE é um tédio
    3. 3. 3 O que é swagger? • Uma interface ao serviço. • É um contrato para o teu serviço. • É uma forma de descrever uma API.
    4. 4. 4 Objetivo • Estabelecer uma interface para APIs Rest independeente da linguagem. • Que permita aos seres humanos e computadores descobrir e compreender as capacidades do serviço sem acesso ao código fonte, documentação, ou rede inspeção de tráfego- through. • Quando adequadamente definido Swagger, um consumidor pode compreender e interagir com o serviço remoto com uma quantidade mínima de lógica de implementação.
    5. 5. 5 Para que serve? • Documentação interativa. • Descrição de todo o que o server pode fazer. • Criar contratos. • Interagir com o serviço remoto.
    6. 6. 6 Swagger UI
    7. 7. 7 Editor Swagger
    8. 8. 8 Antepassados • CORBA • WSDL • WADL
    9. 9. 9 Outras ferramentas atuais • RAML • API Blueprint • entre outros...
    10. 10. 10 Comparação
    11. 11. 11 Comparação RAML SWAGGER API BLUEPRINT Escrever YAML JSON/YAML Markdown Ferramenta de edição Designer de API Editor Swagger - Facilidade para começar Muito facil, tudo esta no github Tudo esta no github Requer instalação Gerador de Documentação Uma página ou multipágina (só php) Uma página Uma página ou multipágina Linguagens JS, Java, Node, PHP, Python, Ruby Clojure, Go, JS, Java, .Net, Node, PHP, Python, Ruby, Scala Node, .Net
    12. 12. 12 Comparação
    13. 13. 13 Swagger no Tech Radar
    14. 14. 14 Links • http://www.slideshare.net/fehguy/swagger-foryourapi • http://www.slideshare.net/fehguy/introducing-swagger • http://www.mikestowe.com/2014/07/raml-vs-swagger-vs-ap • http://www.mikestowe.com/2014/12/api-spec-comparison-t • http://swagger.io/ • https://github.com/swagger-api/ • http://www.thoughtworks.com/radar/tools
    15. 15. Obrigado! Duvidas, sugestões, feedback Nicolás Agustín Torres nagustin@thoughtworks.com

    ×