تنظیمات مخصوص زبان‌ها در SDK Generator
Postman می‌تواند برای چند زبان برنامه‌نویسی SDK بسازد. بعضی تنظیمات بین همه زبان‌ها مشترک‌اند، اما هر زبان گزینه‌های مخصوص خودش را هم دارد. این گزینه‌ها معمولا در بخش languageOptions فایل postman-sdk.config.json قرار می‌گیرند.
SDKهای تولیدشده همچنین می‌توانند قابلیت‌های analytics و observability داشته باشند. این قابلیت‌ها بر پایه OpenTelemetry و OTLP کار می‌کنند و برای بررسی درخواست‌ها، پاسخ‌ها و خطاها مفید هستند.
TypeScript
گزینه‌های TypeScript برای تنظیم نام package و رفتار خروجی npm استفاده می‌شوند.
- تعیین scope برای نام package در npm.
- تعیین نام package.
- انتخاب HTTP client بین
Axios،Fetchیا ماژولhttpsدر Node.js. - فعال‌سازی bundle با
tsup، مخصوصا برای استفاده در محیط browser. - تنظیم
exportClassDefaultبرای export کردن کلاس اصلی SDK به صورت default export.
Java
گزینه‌های Java روی فایل pom.xml و namespace کلاس‌های SDK اثر می‌گذارند.
groupId: شناسه گروه Maven و namespace اصلی.artifactId: شناسه artifact و نام کلاس اصلی SDK.developers: اطلاعات توسعه‌دهندگان شاملname،email،organizationوorganizationUrl.
Kotlin
گزینه‌های Kotlin شبیه Java هستند، اما در ساختار Kotlin و فایل‌های Gradle استفاده می‌شوند.
groupId: شناسه گروه و namespace.artifactId: نام artifact منتشرشده و نام SDK.developers: اطلاعات توسعه‌دهندگان برای انتشار Maven درbuild.gradle.kts.
Python
گزینه‌های Python بیشتر برای آماده‌سازی package جهت انتشار در PyPI استفاده می‌شوند و در pyproject.toml نوشته می‌شوند.
- نام package در PyPI.
- نسخه package.
- توضیح کوتاه package.
- مسیر README برای long description.
- حداقل نسخه Python، مثل
>=3.8. - license، مثل
MITیاApache-2.0. - authors با
nameوemail. - keywords برای بهتر پیدا شدن package.
- classifiers برای مشخص‌کردن مخاطب، license، نسخه زبان و اطلاعات مشابه.
C#
گزینه‌های C# روی package مخصوص NuGet و namespace اصلی اثر دارند.
- Package ID و root namespace برای کلاس‌هایی مثل
Config،ModelsوServices. - authors برای مقدار
<Authors>در فایل.csproj. - homepage URL برای مقدار
<PackageProjectUrl>.
Go
در Go مهم‌ترین گزینه، مسیر module است.
- module path که در
go.modنوشته می‌شود و در import pathهای داخلی استفاده می‌شود؛ مثلgithub.com/your-org/your-sdk. - homepage URL که در README تولیدشده نوشته می‌شود.
اگر می‌خواهید module عمومی منتشر کنید، مسیر module باید با URL repository هماهنگ باشد تا go get بتواند آن را پیدا کند.
PHP
گزینه‌های PHP برای Composer و Packagist استفاده می‌شوند.
- نام package در Composer، مثل
your-org/your-sdk. - authors با
nameوemail. - homepage URL در
composer.json.
Ruby
گزینه‌های Ruby برای فایل gemspec و انتشار در RubyGems استفاده می‌شوند.
- نسخه gem.
- توضیح gem.
- authors با
nameوemail. - homepage URL.
- license، مثل
MITیاApache-2.0.
Rust
گزینه‌های Rust در Cargo.toml نوشته می‌شوند و برای انتشار crate در crates.io کاربرد دارند.
- نام crate، مثل
your-org-sdk. - authors با قالب
Name <email@example.com>. - homepage URL.
- repository URL.
CLI
گزینه‌های CLI برای SDKهای command-line استفاده می‌شوند.
- فعال یا غیرفعال کردن قابلیت‌های CLI skills با گزینه
enabled. - تنظیم مسیر Go module برای CLI SDK، مثل
github.com/your-org/your-cli-sdk.
Analytics
برای تنظیم observability می‌توانید بخش analytics را مطابق نیاز زیرساخت خود تغییر دهید.
- آدرس OTLP endpoint برای trace data.
- نوع exporter، مثل
otlp-httpیاconsole. - headerهای سفارشی HTTP برای احراز هویت.
- حداکثر تعداد span در هر batch.
- تاخیر بین exportها بر حسب میلی‌ثانیه.
- timeout عملیات export بر حسب میلی‌ثانیه.
منبع آموزشی: Postman Docs، بازنویسی و ساده‌سازی‌شده برای کاربران فارسی‌زبان.