مستند کردن APIs
مستند کردن APIها در Postman
آخرین بهروزرسانی: 1405-04-15مستند کردن APIها در Postman مستندات بخش مهمی از هر API است. کاربر API باید بداند چه endpointهایی وجود دارد، چطور باید request بفرستد، چه نوع احراز هویتی لازم است و از responseها چه انتظاری داشته باشد. Postman برای انتشار مستندات API دو مسیر اصلی دارد: مستندات داخلی Postman برای انتشار سریع API reference، و...
مستندسازی APIها در Postman
آخرین بهروزرسانی: 1405-04-15مستندسازی APIها در Postman Postman برای collectionها و APIهای شما به صورت خودکار مستندات میسازد. این مستندات نقطه شروع خوبی است، اما برای اینکه کاربران راحتتر API را بفهمند، بهتر است توضیح، تصویر، ویدیو و جزئیات بیشتر به آن اضافه کنید. مستند کردن collectionها و APIها وقتی یک collection میسازید، Postman برای آن مستندات پایه...
مستند کردن collection در Postman
آخرین بهروزرسانی: 1405-04-15مستند کردن collection در Postman Postman برای هر collection که میسازید، مستندات پایه تولید میکند. این مستندات شامل جزئیات requestهای داخل collection و نمونه کد در زبانهای مختلف است. جزئیات request میتواند method، نوع authorization، URL، headerها، ساختار request و response و exampleها را شامل شود. key-value pairهای مربوط به parameterها، headerها و body هم...
افزودن مستندات API در Postman
آخرین بهروزرسانی: 1405-04-15افزودن مستندات API در Postman در Postman میتوانید مستندات API را با کمک collectionها مشاهده، ایجاد و مدیریت کنید. اگر از types در collection استفاده کنید، میتوانید جزئیات دقیقتری برای parameterها، headerها و body در HTTP collection اضافه کنید. مستندات API میتواند اطلاعات کامل API، path و operation را نشان دهد؛ از جمله روشهای authentication،...
نوشتن و ویرایش مستندات در Postman
آخرین بهروزرسانی: 1405-04-15نوشتن و ویرایش مستندات در Postman Postman برای هر collection که میسازید، از جمله collectionهایی که به API لینک شدهاند، مستندات تولید میکند. هر description که بنویسید در مستندات کامل collection نمایش داده میشود؛ همراه با requestها، exampleها، جزئیات authorization و نمونه کد. برای اینکه همتیمیها یا کاربران عمومی بهتر بفهمند چه چیزی ساختهاید، برای...
انتشار مستندات در Postman
آخرین بهروزرسانی: 1405-04-15انتشار مستندات در Postman وقتی مستندات را publish میکنید، هر کسی که لینک مستندات را داشته باشد میتواند آن را ببیند. این کار برای آموزش استفاده از collection یا معرفی API عمومی شما به کاربران بیرونی مفید است. مستندات عمومی به صورت خودکار جزئیات هر request یا endpoint، نمونه کد در زبانهای مختلف و اطلاعات...
مشاهده مستندات در Postman
آخرین بهروزرسانی: 1405-04-15مشاهده مستندات در Postman مستندات کمک میکند از collectionها و APIهایی که در Postman با آنها کار میکنید بهتر استفاده کنید. با مشاهده مستندات میتوانید بفهمید requestهای یک collection چه کاری انجام میدهند یا چطور باید با endpointهای یک API تعامل داشته باشید. به صورت پیشفرض، مستندات یک collection یا API خصوصی است. شما میتوانید...
میزبانی مستندات API با دامنه اختصاصی در Postman
آخرین بهروزرسانی: 1405-04-15میزبانی مستندات API با دامنه اختصاصی در Postman این قابلیت در پلنهای paid Postman در دسترس است. با custom domain میتوانید مستندات API منتشرشده را به جای دامنه getpostman.com روی دامنه اختصاصی خودتان میزبانی کنید. بعد از اضافه و verify کردن دامنه، کاربران مستندات API شما را از همان دامنه اختصاصی باز میکنند. اضافه کردن...
راهاندازی Guided Auth برای APIهای عمومی در Postman
آخرین بهروزرسانی: 1405-04-15راهاندازی Guided Auth برای APIهای عمومی در Postman با Guided Auth میتوانید مسیر شروع کار با API عمومی خود را برای مصرفکنندهها ساده کنید. در این حالت به کاربران توضیح میدهید برای ارسال اولین request چه کارهایی لازم است؛ مثلا ساخت حساب توسعهدهنده، ساخت app در dashboard شما یا دریافت token. وقتی کاربر در Postman...
