Artykuł przedstawia spojrzenie na dokumentacje API okiem developera. Jest to o tyle istotne, że obecnie wiele firm stawia na rozwój API i traktowanie ich jak pełnoprawne produkty, a całkiem spora część z nich opiera na API swoje modele biznesowe. W przypadku API bezpośrednimi użytkownikami są developerzy, którzy się z nim integrują, ale z dokumentacji API mogą korzystać też inne osoby. Z artykułu przeczytasz o tym:
- Kto i w jakim celu korzysta z dokumentacji
- Jakim językiem powinna być napisana dokumentacja
- Jakie elementy powinna ona zawierać
- Dokumentacja API ma wpływ także na markę firmy i potencjalne przychody.
https://bradfordfults.com/business/the-best-api-documentation/
Kompendium wiedzy odnośnie ogólnie przyjętego standardu opisywania REST API tj. OpenAPI Specification (dawniej Swagger specification). Zapewne dla większości zawarte tam materiały są zbyt mocno technicznie opisane, ale zapoznanie się z samą strukturą specyfikacji pozwala:
- Lepiej zrozumieć API samo w sobie
- Dowiedzieć się jak powinny być opisywane API tworzone w ramach naszych produktów