مستندسازی API نقش بسیار مهمی در سهولت استفاده دیگر توسعهدهندگان از وبسرویسها ایفا میکند. APIهایی که ما طراحی و پیادهسازی میکنیم ممکن است نهتنها توسط اعضای دیگر تیم یا تیمهای مختلف در داخل شرکت مورد استفاده قرار بگیرند، بلکه احتمال دارد توسعهدهندگان بیشماری خارج از سازمان نیز از آنها بهره ببرند. هرچه دامنه استفاده از یک API گستردهتر شود، نیاز به مستندسازی دقیقتر و حرفهایتر نیز بیشتر احساس میشود.
بهعنوان نمونه، اگر به وبسایتهایی مانند تلگرام یا اینستاگرام مراجعه کنید، مشاهده خواهید کرد که آنها برای APIهای خود مستندات کاملی در اختیار عموم قرار دادهاند تا استفاده از این سرویسها ساده و قابل فهم باشد. ما نیز باید برای تمامی APIهایی که توسعه میدهیم—even اگر تنها یک نفر در تیم خودمان قرار است از آنها استفاده کند—مستندات مناسبی تهیه کنیم.
این مستندات باید شامل موارد زیر باشد: