March 2025
Intermediate to advanced
352 pages
9h 30m
Portuguese (Portugal, Brazil)
Content preview from APIs práticas para IA e ciência de dados
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.
Capítulo 5. Documentar a tua API
Este trabalho foi traduzido com recurso a IA. Agradecemos o teu feedback e comentários: translation-feedback@oreilly.com
A documentação é onde os programadores vêm para aprender sobre a tua API. Quer estejas a fornecer um simples ficheiro README ou a desenvolver um site completo para os teus programadores, é fundamental documentar claramente como podem utilizar a tua API da forma mais eficaz.
Brenda Jin, Saurabh Sahni e Amir Shevat, Designing Web APIs (O'Reilly, 2018)
No Capítulo 4, criaste a tua primeira API para cumprir as histórias de utilizador identificadas no Capítulo 1. Os principais utilizadores para quem as desenvolveste são utilizadores de ciência de dados e fornecedores de sites de aconselhamento. A API permitirá que eles criem produtos analíticos, como painéis, gráficos e modelos, usando os dados de fantasia do SportsWorldCentral (SWC). Agora vais criar documentação para os ajudar a utilizar a tua API. A documentação e as funcionalidades como os kits de desenvolvimento de software (SDKs) melhoram a experiência do programador (DX) para os teus utilizadores técnicos.
Enviar um sinal de confiança
Um trabalho importante da tua API docs é sinalizar confiança aos potenciais consumidores da API. Se não confiarem em ti, não utilizarão a tua API. Se os consumidores da API vão chamar a tua API várias vezes, vão construir uma integração, que é basicamente um código que chama o teu código repetidamente. No caso da API do SWC, pode ser um site ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access
More than 5,000 organizations count on O’Reilly
O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.Julian F.
I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.Addison B.
I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.Amir M.
I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.