دسته‌ها را مشاهده کنید

تولیدکننده SDK

20 مستندات

آشنایی با Postman SDK Generator

آخرین به‌روزرسانی: 1405-04-15

Postman SDK Generator collectionها و specificationهای Postman را به client SDK تبدیل می‌کند. این قابلیت برای پلن‌های Postman Team و Enterprise در دسترس است. SDK Generator می‌تواند برای TypeScript، Python، Java، Kotlin، C#، Go، PHP، Ruby و Rust کتابخانه client بسازد. خروجی شامل methodهای خودکار، typeهای inferred و مستندات API است. SDK Generator چه کاری...

تولید SDK در Postman

آخرین به‌روزرسانی: 1405-04-15

در Postman می‌توانید از روی collection یا API specification، SDK تولید کنید. این کار هم از داخل برنامه Postman انجام می‌شود و هم با Postman CLI. خروجی SDK به صورت فایل قابل دانلود است و همراه آن مستندات خودکار هم ساخته می‌شود. اگر SDK را به GitHub وصل کنید، Postman می‌تواند کد تولیدشده را در...

استفاده از SDKهای تولیدشده در Postman

آخرین به‌روزرسانی: 1405-04-15

Postman SDK Generator از روی OpenAPI specification یا Postman Collection، SDK آماده استفاده می‌سازد. هدف این است که به‌جای نوشتن دستی client برای API، یک کتابخانه منظم و قابل استفاده در پروژه داشته باشید. هر SDK شامل چه چیزهایی است؟ Type-safe models: modelهایی برای ساختار request و response. Service classes: کلاس‌هایی برای گروه‌های endpointهای API....

استفاده از SDKهای TypeScript تولیدشده در Postman

آخرین به‌روزرسانی: 1405-04-15

این راهنما روش استفاده از SDKهای TypeScript تولیدشده با Postman SDK Generator را توضیح می‌دهد: ساختار SDK، اجرای مثال، import محلی، انتشار در npm، authentication، environment، error handling و تنظیم timeout/retry. ساختار SDK TypeScript src/index.ts: نقطه ورود اصلی و محل export کردن client، serviceها و modelها. src/services/: کلاس‌های service کنار modelهای مربوط به همان service....

استفاده از SDKهای Java تولیدشده در Postman

آخرین به‌روزرسانی: 1405-04-15

این راهنما روش استفاده از SDKهای Java تولیدشده با Postman SDK Generator را توضیح می‌دهد: ساختار SDK، اجرای example، import با Maven یا Gradle، انتشار در Maven Central، authentication، فراخوانی sync/async، تنظیمات چندسطحی، error handling، validation و optional/nullable fieldها. ساختار SDK Java [SdkName].java: client اصلی SDK که با [SdkName]Config ساخته می‌شود. services/: کلاس‌های service با...

استفاده از SDKهای Kotlin تولیدشده در Postman

آخرین به‌روزرسانی: 1405-04-15

این راهنما روش استفاده از SDKهای Kotlin تولیدشده با Postman SDK Generator را توضیح می‌دهد. خروجی Kotlin برای پروژه‌های JVM مناسب است و معمولا با Gradle یا Maven وارد پروژه می‌شود. ساختار کلی آن شبیه SDKهای Java است، اما نمونه‌ها و importها برای Kotlin نوشته شده‌اند. ساختار SDK Kotlin [SdkName].kt: client اصلی SDK که با...

استفاده از SDKهای Python تولیدشده در Postman

آخرین به‌روزرسانی: 1405-04-15

این راهنما روش استفاده از SDKهای Python تولیدشده با Postman SDK Generator را توضیح می‌دهد. SDK پایتون برای model validation، type safety و serialization از Pydantic استفاده می‌کند و برای نصب محلی، توسعه و انتشار در PyPI آماده است. ساختار SDK Python your_sdk/: package اصلی SDK. services/: کلاس‌ها یا moduleهای service برای endpointها. models/: مدل‌های...

استفاده از SDKهای C# تولیدشده در Postman

آخرین به‌روزرسانی: 1405-04-15

این راهنما روش استفاده از SDKهای C# تولیدشده با Postman SDK Generator را توضیح می‌دهد. این SDKها برای پروژه‌های .NET آماده‌اند و شامل client، serviceها، modelها، authentication، validation، retry و error handling هستند. ساختار SDK C# src/: کد اصلی SDK. Services/: service classها برای endpoint groupها. Models/: modelهای request/response و exceptionهای typed. Http/: HTTP client،...

استفاده از SDKهای Go تولیدشده در Postman

آخرین به‌روزرسانی: 1405-04-15

این راهنما روش استفاده از SDKهای Go تولیدشده با Postman SDK Generator را توضیح می‌دهد. SDK Go به صورت module قابل نصب است و برای کار با context، error handling، environment، retry و validation آماده می‌شود. ساختار SDK Go client.go: client اصلی SDK. services/: serviceها و methodهای API. models/: structهای request/response و error modelها. config/:...

استفاده از SDKهای PHP تولیدشده در Postman

آخرین به‌روزرسانی: 1405-04-15

این راهنما روش استفاده از SDKهای PHP تولیدشده با Postman SDK Generator را توضیح می‌دهد. خروجی PHP با Composer کار می‌کند و برای نصب محلی، انتشار در Packagist، authentication، error handling، environment، retry و optional/nullable fieldها آماده است. ساختار SDK PHP src/: کد اصلی SDK. Services/: service classها برای endpoint groupها. Models/: modelهای request/response و...

استفاده از SDKهای Ruby تولیدشده در Postman

آخرین به‌روزرسانی: 1405-04-15

این راهنما روش استفاده از SDKهای Ruby تولیدشده با Postman SDK Generator را توضیح می‌دهد. SDK Ruby با conventionهای Ruby مثل snake_case، Bundler و RubyGems هماهنگ است. ساختار SDK Ruby lib/: کد اصلی gem. services/: serviceهای API. models/: modelهای request/response و errorها. Gemfile: dependencyهای توسعه. *.gemspec: metadata و تنظیمات انتشار gem. Ruby conventions و serialization...

استفاده از SDKهای Rust تولیدشده در Postman

آخرین به‌روزرسانی: 1405-04-15

این راهنما روش استفاده از SDKهای Rust تولیدشده با Postman SDK Generator را توضیح می‌دهد. SDK Rust روی type safety، serialization با Serde، error handling صریح، نصب با Cargo و انتشار در crates.io تمرکز دارد. ساختار SDK Rust src/lib.rs: نقطه ورود crate و exportهای اصلی. src/client.rs: client اصلی SDK. src/services/: serviceها برای endpointها. src/models/: structها...

پیکربندی تولید SDK در Postman

آخرین به‌روزرسانی: 1405-04-15

برای کنترل خروجی SDK Generator می‌توانید از فایل پیکربندی Postman SDK استفاده کنید. این فایل مشخص می‌کند SDK با چه نام package، چه زبان، چه گزینه‌هایی برای code generation و چه تنظیمات پیشرفته‌ای ساخته شود. ساخت و مدیریت فایل config تولید SDK فایل config معمولا در کنار collection یا specification و کد SDK نگهداری می‌شود...

گزینه‌های اصلی پیکربندی Postman SDK

آخرین به‌روزرسانی: 1405-04-15

گزینه‌های اصلی در فایل پیکربندی SDK گزینه‌های اصلی Postman SDK، تنظیمات پایه تولید SDK را مشخص می‌کنند؛ مثل نام SDK، نام و نسخه API، آدرس پایه API، زبان‌هایی که باید برای آن‌ها SDK ساخته شود و روش احراز هویت. این گزینه‌ها در سطح اصلی فایل postman-sdk.config.json قرار می‌گیرند. sdkName با sdkName نام SDK را تعیین...

گزینه‌های سفارشی‌سازی Postman SDK

آخرین به‌روزرسانی: 1405-04-15

سفارشی‌سازی SDK در Postman بخش customizations در فایل postman-sdk.config.json برای تغییر رفتار SDKهای تولیدشده استفاده می‌شود. با این بخش می‌توانید جزئیات احراز هویت و رفتار ادغام کد سفارشی را کنترل کنید. سفارشی‌سازی احراز هویت گزینه‌های authentication زمانی کاربرد دارند که در بخش auth روش احراز هویت API را مشخص کرده باشید. این تنظیمات به شما...

گزینه‌های زبان‌ها در Postman SDK

آخرین به‌روزرسانی: 1405-04-15

تنظیمات مخصوص زبان‌ها در SDK Generator Postman می‌تواند برای چند زبان برنامه‌نویسی SDK بسازد. بعضی تنظیمات بین همه زبان‌ها مشترک‌اند، اما هر زبان گزینه‌های مخصوص خودش را هم دارد. این گزینه‌ها معمولا در بخش languageOptions فایل postman-sdk.config.json قرار می‌گیرند. SDKهای تولیدشده همچنین می‌توانند قابلیت‌های analytics و observability داشته باشند. این قابلیت‌ها بر پایه OpenTelemetry و...

رفع خطاهای SDK در Postman

آخرین به‌روزرسانی: 1405-04-15

راهنمای سریع رفع خطاهای SDK Generator اگر هنگام استفاده از Postman SDK Generator یا دستورهای CLI با خطا روبه‌رو شدید، اول نوع عملیات را مشخص کنید: تولید SDK، گرفتن خروجی، اتصال به repository، ساخت PR یا دانلود artifact. سپس پیام خطا را با بخش‌های زیر تطبیق دهید. در بیشتر خطاها، راه‌حل از یکی از این...

راهنماهای Postman SDK Generator

آخرین به‌روزرسانی: 1405-04-15

راهنماهای کاربردی SDK Generator Postman SDK Generator می‌تواند از روی Postman Collection یا مشخصات API، SDK سمت کلاینت بسازد. این SDKها برای زبان‌های مختلف تولید می‌شوند و شامل متدهای آماده، نوع‌دهی مناسب، نمونه کد و مستندات هستند. این بخش راهنماهای عملی SDK Generator را معرفی می‌کند؛ از تولید ساده SDK تا نگهداری کد سفارشی و...

تولید SDK با کد سفارشی در Postman CLI

آخرین به‌روزرسانی: 1405-04-15

تولید SDK و حفظ کدهای سفارشی با Postman CLI می‌توانید از روی Collection یا API specification یک SDK بسازید، بعد روی فایل‌های تولیدشده تغییرات خودتان را اضافه کنید و در تولیدهای بعدی آن تغییرات را حفظ کنید. این قابلیت برای زمانی مفید است که می‌خواهید متد کمکی، logging، validation، README اختصاصی یا منطق مخصوص برنامه...

خودکارسازی به‌روزرسانی SDK با Postman و GitHub

آخرین به‌روزرسانی: 1405-04-15

به‌روزرسانی خودکار SDK با GitHub Postman می‌تواند از روی Collection یا specification، SDK بسازد و آن را به یک repository در GitHub وصل کند. بعد از اتصال، تغییرات Collection یا specification می‌توانند باعث ساخت SDK جدید و ایجاد Pull Request در repository شوند. این قابلیت برای به‌روزرسانی خودکار SDK در پلن‌های Enterprise Postman در دسترس...