Postman SDK Generator از روی OpenAPI specification یا Postman Collection، SDK آماده استفاده می‌سازد. هدف این است که به‌جای نوشتن دستی client برای API، یک کتابخانه منظم و قابل استفاده در پروژه داشته باشید.
هر SDK شامل چه چیزهایی است؟
- Type-safe models: modelهایی برای ساختار request و response.
- Service classes: کلاس‌هایی برای گروه‌های endpointهای API.
- Authentication handling: پشتیبانی از API Key، Bearer Token، Basic Auth و OAuth، بسته به spec شما.
- Built-in error handling: خطاهای مشخص برای API و validation.
- Example projects: نمونه پروژه برای شروع سریع.
- Comprehensive documentation: توضیح serviceها، modelها و نمونه‌های استفاده.
راهنماهای زبان‌ها
برای نصب و استفاده از SDK، راهنمای زبان مورد نظر را دنبال کنید. هر راهنما نمونه کد، روش import، روش publish، authentication، مدیریت environment و الگوی error handling را توضیح می‌دهد.
- Use TypeScript SDKs generated in Postman
- Use Java SDKs generated in Postman
- Use Kotlin SDKs generated in Postman
- Use Python SDKs generated in Postman
- Use C# SDKs generated in Postman
- Use Go SDKs generated in Postman
- Use PHP SDKs generated in Postman
- Use Ruby SDKs generated in Postman
- Use Rust SDKs generated in Postman
اگر تازه شروع کرده‌اید، اول نمونه پروژه داخل پوشه examples/ را اجرا کنید. بعد از آن SDK را به پروژه اصلی خود اضافه کنید و authentication و base URL را با محیط واقعی تنظیم کنید.
منبع آموزشی: Postman Docs، بازنویسی و ساده‌سازی‌شده برای کاربران فارسی‌زبان.