Fern برای مستندسازی API در Postman
Fern یک پلتفرم docs-as-code است که می‌تواند از روی Postman Collection، یک سایت مستندات کامل بسازد. وقتی Collection را منتشر می‌کنید، Fern به صورت خودکار API reference را تولید می‌کند و بعد می‌توانید guide، tutorial و محتوای تکمیلی اضافه کنید.
Fern چطور کار می‌کند؟
وقتی یک Postman Collection را با Fern منتشر می‌کنید، مستندات شما روی یک سایت زنده deploy می‌شود. پشت این سایت یک GitHub repository قرار دارد که متعلق به تیم شماست، بنابراین مالکیت و امکان ویرایش کامل دارید.
بعد از انتشار، می‌توانید ظاهر، محتوا و ساختار سایت را مطابق نیاز تیم یا محصول خود تغییر دهید.
مستندات Fern شامل چه چیزهایی است؟
- API reference: به صورت خودکار از Collection ساخته می‌شود و شامل جزئیات requestها، sample code و API explorer تعاملی است. کاربران می‌توانند از داخل مستندات API call واقعی اجرا کنند.
- Guide و tutorial: می‌توانید صفحه‌های معرفی، راهنمای شروع سریع، آموزش‌ها و محتوای توضیحی را کنار API reference اضافه کنید.
- قابلیت‌های AI-powered: جست‌وجوی هوشمند با Ask Fern و ابزار Fern Writer برای کمک به نوشتن یا به‌روزرسانی محتوا.
- Branding سفارشی: امکان تنظیم نام سایت، رنگ‌ها، لوگو، دامنه اختصاصی و موارد ظاهری دیگر.
شروع کار با Fern
برای انتشار مستندات Collection با Fern، باید جریان «Document a collection with Fern» را دنبال کنید. بعد از انتشار، مدیریت مستندات از طریق Fern Dashboard انجام می‌شود.
از داخل Postman هم می‌توانید مستندات منتشرشده را ویرایش کنید یا در صورت نیاز سایت را unpublish کنید.
منبع آموزشی: Postman Docs، بازنویسی و ساده‌سازی‌شده برای کاربران فارسی‌زبان.