#84 Tech Writer gada z aplikacją, czyli podstawy używania REST API
Application Programming Interface (API) pozwala na komunikację pomiędzy programami. Ma ściśle określone reguły, które mówią nam w jaki sposób możemy zażądać informacji od jakiejś aplikacji i czego możemy spodziewać się w odpowiedzi.
Czy taka wiedza jest potrzebna Tech Writerom? Według nas jak najbardziej, szczególnie jeśli tworzą dokumentację dla deweloperów. Ten odcinek to podsumowanie wiedzy jaką przekazaliśmy uczestnikom podczas darmowych warsztatów "Using REST APIs for Technical Writers", które przeprowadziliśmy 28.11.2025 przy współpracy z Content Bytes.
Rozmawiamy o tym czym jest API, jak sformułować żądanie, które pozwoli nam otrzymać odpowiedź, jakie typy żądań i odpowiedzi istnieją, jakich narzędzi możemy użyć i o innych podstawach, które ułatwią technoskrybom wejście w świat interakcji z aplikacjami poprzez API.
Dźwięki wykorzystane w audycji pochodzą z kolekcji "107 Free Retro Game Sounds" dostępnej na stronie https://dominik-braun.net, udostępnianej na podstawie licencji Creative Commons license CC BY 4.0 (https://creativecommons.org/licenses/by/4.0/).
Linki:
- CAKE conf: https://cakeconf.contentbytes.pl/
- "API", Wikipedia: https://en.wikipedia.org/wiki/API
- "What Is a REST API? Examples, Uses, and Challenges", Postman Blog: https://blog.postman.com/rest-api-examples/
- "SOAP", Wikipedia: https://en.wikipedia.org/wiki/SOAP
- Swagger UI: https://swagger.io/tools/swagger-ui/
- OpenAPI: https://www.openapis.org/
- cURL: https://curl.se/
- Visual Studio (VS) Code: https://code.visualstudio.com
- REST Client: https://marketplace.visualstudio.com/items?itemName=humao.rest-client
- Postman API client: https://www.postman.com/product/api-client/
- Requestly: https://requestly.com/