Importância da documentação de APIs e como fazer

A ideia é mostrar que toda aplicação desenvolvida necessita de uma documentação mínima para entendimento futuro e de sua utilização.

Serão mostradas algumas ferramentas open-source para documentar uma API de maneira fácil e integrada a diversas linguagens de programação.

Transcript

1. Importância da documentação de APIs e como fazer By Frederick Moschkowich
2. Frederick Moschkowich Analista de sistemas no Parque Tecnológico Itaipu Professor do curso de Engª de Software na UniAmérica Quem sou eu? fredmosc
3. O que é uma API? “Application Programming Interface – conjunto de rotinas e padrões de programação estabelecidos por um software para utilização das suas funcionalidades por aplicativos que não pretendem envolver-se da implementação do software, mas apenas usar seus serviços.” Fonte: https://foldoc.org/Application+Program+Interface
4. Tipos de API • Privadas; • Parceiros; • Públicas https://www.seobility.net/en/wiki/REST_API
5. Agilidade x Praticidade • Devemos não usar processos e ferramentas? • Devemos não ter negociação de contratos? • Não devemos seguir um plano? • E por que deveríamos esquecer a documentação?
6. Documentação
7. Exemplos Fonte: https://developers.google.com/youtube/v3/code_samples/javascript
8. Centralizar informações
9. Se liga nos erros!!
10. Interatividade
11. Teste
12. Ferramentas
13. Vamos para prática!
14. Obrigado! Caso queiram entrar em contato fiquem a vontade! frederick.nazario@pti.org.br +55 45 99909-3276 pti.org.br fredmosc