چگونه یک REST API ایجاد کنیم؟

سلام! من به عنوان یک تامین کننده API، مشتاقم تا نحوه ایجاد یک REST API را با شما به اشتراک بگذارم. REST که مخفف Representational State Transfer است، یک سبک معماری پرکاربرد برای ساخت سرویس های وب است. این فوق العاده انعطاف پذیر، مقیاس پذیر و قابل درک است و آن را به بهترین انتخاب برای توسعه دهندگان در سراسر جهان تبدیل می کند.

درک اصول REST

قبل از اینکه به ایجاد یک REST API بپردازیم، اجازه دهید سریعاً به آنچه REST است بپردازیم. REST بر اساس مجموعه ای از اصول است که خدمات وب را کارآمدتر و قابل اعتمادتر می کند. مفاهیم کلیدی شامل منابع است، که داده ها یا اشیایی هستند که می خواهید از طریق API خود در معرض نمایش قرار دهید، و روش های HTTP مانند GET، POST، PUT و DELETE.

• دریافت کنید: برای بازیابی یک منبع استفاده می شود. برای مثال، اگر یک API برای یک کتابخانه دارید، می‌توان از درخواست GET برای دریافت فهرستی از همه کتاب‌ها استفاده کرد.
• ارسال کنید: برای ایجاد یک منبع جدید استفاده می شود. در مثال کتابخانه، یک درخواست POST می تواند برای افزودن یک کتاب جدید به مجموعه استفاده شود.
• قرار دادن: برای به روز رسانی یک منبع موجود استفاده می شود. می توانید از یک درخواست PUT برای به روز رسانی جزئیات یک کتاب خاص استفاده کنید.
• حذف کنید: برای حذف یک منبع استفاده می شود. بنابراین، اگر می‌خواهید کتابی را از کتابخانه حذف کنید، از درخواست DELETE استفاده کنید.

برنامه ریزی REST API شما

اولین قدم در ایجاد REST API برنامه ریزی است. شما باید بفهمید که چه منابعی را می خواهید در معرض دید قرار دهید و چگونه سازماندهی می شوند. به مدل های داده و روابط بین منابع مختلف فکر کنید. به عنوان مثال، اگر در حال ساختن یک API برای یک فروشگاه تجارت الکترونیک هستید، ممکن است منابعی مانند محصولات، مشتریان و سفارشات داشته باشید.

شما همچنین باید در مورد نقاط پایانی API تصمیم بگیرید. اینها URL هایی هستند که مشتریان برای تعامل با API شما استفاده می کنند. یک تمرین خوب این است که از اسم ها برای نشان دادن منابع در نقاط پایانی خود استفاده کنید. به عنوان مثال،/محصولاتمی تواند نقطه پایانی برای دریافت لیستی از همه محصولات باشد، و/products/{product_id}می تواند برای دریافت جزئیات یک محصول خاص استفاده شود.

راه اندازی محیط توسعه

هنگامی که API خود را برنامه ریزی کردید، زمان آن است که محیط توسعه خود را تنظیم کنید. شما به یک زبان برنامه نویسی و یک چارچوب نیاز دارید. گزینه های محبوب برای ساخت API های REST عبارتند از Python با Flask یا Django، Node.js با Express و جاوا با Spring Boot.

فرض کنید پایتون و فلاسک را انتخاب کرده اید. اگر قبلاً نصب نکرده اید ابتدا باید پایتون را نصب کنید. سپس، می توانید Flask را با استفاده از آن نصب کنیدفلاسک نصب پیپ. در اینجا یک مثال ساده از یک برنامه Flask است که یک REST API اصلی ایجاد می کند:

from flask import Flask, jsonify app = Flask(__name__) @app.route('/') def index(): return jsonify({'message': 'به API ما خوش آمدید!'}) اگر __name__ == '__main__': app.run(debug=True)

در این مثال، ما یک API ساده با یک نقطه پایانی (/) که پاسخ JSON را برمی گرداند.

پیاده سازی نقاط پایانی API

اکنون که محیط شما راه اندازی شده است، زمان اجرای نقاط پایانی API است. بیایید با مثال تجارت الکترونیکی ادامه دهیم. برای دریافت لیستی از محصولات و افزودن محصول جدید، نقاط پایانی ایجاد خواهیم کرد.

from flask import Flask, jsonify, request app = Flask(__name__) # داده های نمونه برای محصولات محصولات = [ {'id': 1, 'name': 'Product 1', 'price': 10.99}, {'id': 2, 'name': 'Product 2', 'price': 19.9']'product @ro. method=['GET']) def get_products(): return jsonify(products) @app.route('/products', method=['POST']) def add_product(): new_product = request.get_json() products.append(new_product) return jsonify(new_product), 201 if _____ app.run(debug=True)

در این کد،/محصولاتنقطه پایانی با متد GET لیستی از همه محصولات را برمی گرداند و همان نقطه پایانی با روش POST یک محصول جدید را به لیست اضافه می کند.

رسیدگی به خطاها و اعتبارسنجی

یک REST API خوب باید خطاها را به خوبی مدیریت کند و ورودی را تأیید کند. به عنوان مثال، اگر مشتری درخواست نامعتبری ارسال کند، API شما باید یک پیام خطای مناسب را ارسال کند.

from flask import Flask, jsonify, request app = Flask(__name__) products = [ {'id': 1, 'name': 'Product 1', 'price': 10.99}, {'id': 2, 'name': 'Product 2', 'price': 19.99}: 19.99} ]deGood: 19.99} ]@rof. get_products(): بازگشت jsonify(products) @app.route('/products', method=['POST']) def add_product(): new_product = request.get_json() اگر new_product یا 'name' در new_product نیست یا 'price' در new_product نیست: jsonify({'error') را بازگردانید({'error') داده‌های محصول نامعتبر، محصول 4 بازگشت: '0 محصول نامعتبر است. jsonify(new_product)، 201 if __name__ == '__main__': app.run(debug=True)

در اینجا، اعتبارسنجی را به آن اضافه کرده‌ایمافزودن_محصولتابع اگر مشتری داده های محصول معتبری را ارسال نکند، API یک خطای 400 Bad Request را برمی گرداند.

ایمن کردن REST API شما

وقتی صحبت از API های REST می شود، امنیت بسیار مهم است. شما باید API خود را از دسترسی غیرمجاز محافظت کنید. یکی از راه های رایج برای انجام این کار استفاده از احراز هویت و مجوز است.

• احراز هویت: این کار هویت مشتری را تأیید می کند. می‌توانید از روش‌هایی مانند کلیدهای API، OAuth یا JSON Web Tokens (JWT) استفاده کنید. به عنوان مثال، اگر از کلیدهای API استفاده می کنید، یک کلاینت برای دسترسی به API باید یک کلید API معتبر در هدرهای درخواست ارسال کند.
• مجوز: این مشخص می کند که یک کلاینت مجاز به انجام چه اقداماتی است. هنگامی که یک کلاینت احراز هویت شد، می توانید بررسی کنید که آیا آنها مجوزهای لازم برای دسترسی به یک منبع خاص یا انجام یک عمل را دارند یا خیر.

تست REST API شما

قبل از استقرار API خود، باید آن را به طور کامل آزمایش کنید. می توانید از ابزارهایی مانند Postman یا cURL برای ارسال درخواست به API خود و بررسی پاسخ ها استفاده کنید.

به عنوان مثال، برای آزمایشدریافت_محصولاتنقطه پایانی با استفاده از cURL، می توانید دستور زیر را اجرا کنید:

حلقه http://127.0.0.1:5000/products

این یک درخواست GET را به/محصولاتنقطه پایانی و نمایش پاسخ.

استقرار REST API شما

هنگامی که API شما آزمایش شد و به درستی کار کرد، زمان آن فرا رسیده است که آن را اجرا کنید. می توانید از پلتفرم های ابری مانند Heroku، AWS یا Google Cloud استفاده کنید. این پلتفرم ها استقرار و مدیریت API شما را آسان می کنند.

پیشنهادات API های ما

به عنوان یک تامین کننده API، ما طیف گسترده ای از API ها را برای صنایع مختلف ارائه می دهیم. به عنوان مثال، ما API هایی برایپودر آمبروکسان 6790 - 58 - 5،پودر کوینین HCL 60 - 93 - 5، وC12 - 20 آلکیل گلوکوزید. این APIها برای دسترسی آسان به داده ها و عملکردهای مرتبط با این محصولات طراحی شده اند و به شما کمک می کنند فرآیندهای تجاری خود را ساده کنید.

برای تهیه با ما تماس بگیرید

اگر به API های ما علاقه مند هستید یا می خواهید درباره ایجاد یک REST API سفارشی برای نیازهای خاص خود بحث کنید، در تماس با ما دریغ نکنید. ما اینجا هستیم تا به شما کمک کنیم از فناوری REST API حداکثر استفاده را ببرید و کسب و کار خود را به سطح بعدی ببرید.

مراجع

• ریچاردسون، لئونارد و سام روبی. خدمات وب RESTful. رسانه اوریلی، 2007.
• جوان، مایک. "RESTful Web API Design." الگوها و شیوه های مایکروسافت، 2013.