اطلاعات ورودی و خروجی داده های ارسال و دریافت شده توسط وب API را مستند کنید تا توسعه دهندگان بتوانند نحوه ساخت برنامه هایی را که می توانند با موفقیت از آن داده ها استفاده کنند، بسازند. پیتر گرونبام، کارشناس برنامه نویسی و نگارش فنی می داند که API ها به طور فزاینده ای اهمیت می یابند، به همین دلیل است که در این دوره، او به شما نشان می دهد که چگونه داده های ساختاریافته را با استفاده از فرمت های تبادل داده مستندسازی کنید تا به شما در ایجاد مهارت های قوی و اساسی در اسناد وب API کمک کند. پیتر مزایای ایجاد مستندات خوب را به اشتراک می‌گذارد، تفاوت‌های بین پاسخ‌ها و درخواست‌ها را توضیح می‌دهد و نحوه کار با انواع داده‌ها و مجموعه‌های رایج - از اعداد و متن گرفته تا آرایه‌ها و فرهنگ‌های لغت را مورد بحث قرار می‌دهد. سپس نحوه ایجاد و مستندسازی داده های ساخت یافته را با استفاده از JSON و سپس XML نشان می دهد. او دوره را با بررسی مزایا و معایب اسناد موجود و ابزارهای همکاری مانند ویکی ها و پایگاه های دانش به پایان می رساند.

 با وجود بسیاری از API های موجود در بازار ، پیگیری آنچه چیست ، دشوار است. برای برنامه نویسان ، تحلیلگران ، معماران و نویسندگان فنی که هر روز با API کار می کنند ، نمی توانید اهمیت مستندات واضح ، مختصر و آسان استفاده کنید. در این دوره ، مربی و توسعه دهنده Deepa Maddala به شما نشان می دهد که چگونه می توانید مستندات API مؤثر و نزدیک را بر اساس بهترین شیوه های فعلی و ابزارهای یکپارچه ایجاد کنید. مؤلفه های مستندات مؤثر از جمله نام ، توضیحات ، نقاط پایانی ، مجوز ، پارامترها ، هدرها و بارهای درخواست و پاسخ را کاوش کنید. در طول راه ، Deepa نکاتی را در مورد نحوه ادغام مستندات خود با ابزارهایی مانند Swagger ، Postman و Confluence به شما ارائه می دهد.