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

این راهنما روش استفاده از 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 از نام‌گذاری Ruby استفاده می‌کند؛ یعنی methodها و fieldها معمولا snake_case هستند، حتی اگر در API با شکل دیگری آمده باشند. هنگام serialization، SDK مقدارها را به format مورد انتظار API تبدیل می‌کند.

user = User.new(
  user_id: '123',
  first_name: 'Sara'
)

puts user.to_h

اجرای نمونه SDK #

cd examples
bundle install
ruby main.rb

require 'your_sdk'

client = YourSdk::Client.new(
  api_key: 'your-api-key',
  base_url: 'https://api.example.com'
)

begin
  user = client.users.get_user('123')
  puts user
rescue StandardError => e
  puts "Error: #{e.message}"
end

نصب SDK Ruby به صورت local #

Bundler با local path #

در Gemfile پروژه، مسیر SDK را اضافه کنید.

gem 'your_sdk', path: '../path/to/your-sdk'

bundle install

Bundler با Git repository #

gem 'your_sdk', git: 'https://github.com/your-org/your-sdk.git', tag: 'v1.0.0'

انتشار در RubyGems #

برای انتشار، gemspec را کامل کنید، gem را build کنید و به RubyGems push کنید.

Gem::Specification.new do |spec|
  spec.name = 'your_sdk'
  spec.version = '1.0.0'
  spec.summary = 'SDK for Your API'
  spec.authors = ['Your Organization']
  spec.files = Dir['lib/**/*', 'README.md', 'LICENSE']
  spec.require_paths = ['lib']
  spec.license = 'MIT'
end

gem build your_sdk.gemspec
gem push your_sdk-1.0.0.gem

برای نسخه جدید، version را در gemspec افزایش دهید و دوباره build/push کنید.

gem build your_sdk.gemspec
gem push your_sdk-1.0.1.gem

بهترین کارها برای Ruby SDK #

• README و نمونه‌های کوتاه داشته باشید.
• از semantic versioning استفاده کنید.
• نام gem را ساده و یکتا انتخاب کنید.
• قبل از انتشار، testها را اجرا کنید.
• dependencyها را در gemspec دقیق نگه دارید.

منابع داخل SDK #

• پوشه documentation/ برای serviceها و modelها.
• پوشه examples/ برای نمونه اجرایی.
• فایل gemspec برای انتشار در RubyGems.
• مدل‌ها و serviceهایی که با naming conventionهای Ruby سازگار شده‌اند.

منبع آموزشی: Postman Docs، بازنویسی و ساده‌سازی‌شده برای کاربران فارسی‌زبان.