تخطَّ إلى المحتوى
1337skills 1337skills - أوراق الغش

أوامر Bruno

Bruno هو عميل API خفيف الوزن ومفتوح المصدر وبتصميم Git-native مصمم لاختبار وتطوير واجهات برمجية التطبيقات. بخلاف Postman، يقوم Bruno بتخزين مجموعاتك كملفات نصية عادية (صيغة .bru) يمكن إدارة إصداراتها باستخدام Git، مما يجعله مثاليًا للتعاون الجماعي وأنابيب CI/CD.

التثبيت

المنصةالأمر
macOS (Homebrew)brew install bruno
Linux (Snap)snap install bruno
Linux (APT)sudo apt-get install bruno
Windows (Chocolatey)choco install bruno
npmnpm install -g @usebruno/cli
تحميلزر usebruno.com/downloads

البدء السريع

تشغيل واجهة Bruno

bruno

إنشاء مجموعة جديدة

bruno create-collection my-api-collection

فتح مجموعة موجودة

bruno /path/to/collection

إدارة المجموعات

هيكل المجموعة

يقوم Bruno بتخزين المجموعات كدلائل تحتوي على ملفات .bru:

my-api-collection/
├── bruno.json          # بيانات المجموعة الوصفية
├── environments/
│   ├── Development.json
│   └── Production.json
├── auth/
│   └── auth.bru
└── users/
    ├── get-all-users.bru
    ├── create-user.bru
    └── update-user.bru

الاستيراد من Postman

# في واجهة Bruno: استيراد → اختر مجموعة Postman JSON
# أو استخدم CLI (إذا كان متوفرًا لإصدار Bruno الخاص بك)

تنظيم الطلبات في مجلدات

قم بإنشاء مجلدات ضمن مجموعتك لتنظيم الطلبات:

  • انقر بزر الماوس الأيمن في شجرة المجموعة → مجلد جديد
  • قم بتسمية المجلدات بشكل منطقي (مثل المستخدمين والمنتجات والمصادقة)
  • اسحب الطلبات بين المجلدات

تصدير المجموعة

# يتم تخزين المجموعات كملفات عادية (صيغة .bru)
# ما عليك سوى الالتزام بـ Git أو مشاركة الدليل

لغة Bru (تنسيق الطلب)

يستخدم Bruno ملفات .bru—لغة ترميز بسيطة وقابلة للقراءة للطلبات.

ملف الطلب الأساسي

meta {
  name: Get All Users
  type: http
  seq: 1
}

get {
  url: {{baseUrl}}/api/users
  auth: bearer
}

params:query {
  limit: 10
  offset: 0
}

headers {
  Content-Type: application/json
  User-Agent: Bruno/v1
}

auth:bearer {
  token: {{authToken}}
}

طلب مع نص الرسالة

meta {
  name: Create User
  type: http
  seq: 2
}

post {
  url: {{baseUrl}}/api/users
}

headers {
  Content-Type: application/json
}

body:json {
  {
    "name": "John Doe",
    "email": "john@example.com",
    "role": "admin"
  }
}

طلب نموذج البيانات

meta {
  name: Upload Profile Picture
  type: http
  seq: 3
}

post {
  url: {{baseUrl}}/api/users/{{userId}}/avatar
}

body:form-urlencoded {
  username: johndoe
  email: john@example.com
}

نموذج متعدد الأجزاء (تحميل ملف)

meta {
  name: Upload File
  type: http
  seq: 4
}

post {
  url: {{baseUrl}}/api/files/upload
}

body:multipartForm {
  file: @/path/to/file.pdf
  description: My document
}

أوامر CLI

تشغيل مجموعة أو طلب

# تشغيل مجموعة كاملة
bru run /path/to/collection

# تشغيل طلب محدد
bru run /path/to/collection/requests/get-users.bru

# تشغيل مع بيئة محددة
bru run /path/to/collection --env Production

# تشغيل بتنسيق JSON reporter
bru run /path/to/collection --reporter json

# تشغيل مع تقرير HTML
bru run /path/to/collection --reporter html --output report.html

المراجعون المتاحون

المراجعالأمر
CLI (افتراضي)bru run collection --reporter cli
JSONbru run collection --reporter json
HTMLbru run collection --reporter html --output report.html
JUnitbru run collection --reporter junit

التشغيل مع المتغيرات

# تمرير متغيرات البيئة
bru run /path/to/collection --env Development

# تجاوز متغير معين
bru run /path/to/collection --env Production --variable apiKey=abc123

الفشل عند حدوث خطأ

# الخروج برمز حالة غير صفري إذا فشل أي اختبار (مفيد لـ CI/CD)
bru run /path/to/collection --failOnError

إخراج تفصيلي

# عرض معلومات الطلب/الاستجابة التفصيلية
bru run /path/to/collection --verbose

متغيرات البيئة

إنشاء ملف بيئة

يتم تخزين ملفات البيئة كـ environments/EnvName.json:

{
  "baseUrl": "https://api.example.com",
  "apiKey": "your-api-key-here",
  "authToken": "bearer-token",
  "userId": "12345",
  "timeout": 5000
}

استخدام المتغيرات في الطلبات

get {
  url: {{baseUrl}}/api/users/{{userId}}
  timeout: {{timeout}}
}

headers {
  Authorization: Bearer {{authToken}}
  X-API-Key: {{apiKey}}
}

التبديل بين البيئات

# عبر CLI
bru run /path/to/collection --env Development

# عبر واجهة Bruno: اختر قائمة البيئة المنسدلة في واجهة Bruno

أنواع متغيرات البيئة

النوعمثالالاستخدام
نص"apiKey": "abc123"{{apiKey}}
رقم"timeout": 5000{{timeout}}
منطقي"debug": true{{debug}}
كائن"config": {...}الوصول عن طريق البرمجة

إدارة الأسرار

# إنشاء ملف .env للبيانات الحساسة (أضفه إلى .gitignore)
echo "PROD_API_KEY=secret123" > .env

# الاستخدام في ملف البيئة مع المرجع
# أو استخدم واجهة Bruno لتعليم الحقول كـ "سري"

نصوص ما قبل الطلب

أضف JavaScript قبل إرسال الطلب:

// تعيين القيم الديناميكية
bru.setEnvVar('timestamp', Date.now());
bru.setEnvVar('nonce', Math.random().toString(36).substring(7));

// منطق شرطي
if (bru.getEnvVar('env') === 'production') {
  bru.setEnvVar('timeout', 10000);
}

// تسجيل معلومات التصحيح
console.log('Sending request to', bru.getEnvVar('baseUrl'));

نصوص ما بعد الاستجابة

تنفيذ JavaScript بعد استقبال الاستجابة:

// الوصول إلى بيانات الاستجابة
const responseData = res.getBody();
const statusCode = res.getStatus();
const headers = res.getHeaders();

// حفظ القيم للطلب التالي
if (statusCode === 200) {
  bru.setEnvVar('authToken', responseData.token);
  bru.setEnvVar('userId', responseData.user.id);
}

// تسجيل الاستجابة
console.log('Status:', statusCode);
console.log('Response:', JSON.stringify(responseData, null, 2));

عمليات الاستجابة الشائعة

// الحصول على رمز الحالة
const status = res.getStatus();

// الحصول على النص كسلسلة نصية
const body = res.getBody();

// تحليل نص JSON
const data = res.getBody(true); // true = تحليل كـ JSON

// الحصول على الرؤوس
const contentType = res.getHeader('content-type');

// الحصول على رأس معين
const authHeader = res.getHeader('authorization');

التأكيدات والاختبارات

التأكيدات المدمجة للاختبار

// تأكيد رمز الحالة
tests['Status is 200'] = (res.getStatus() === 200);

// النص يحتوي على
tests['Response contains user'] = res.getBody().includes('john');

// تحقق من استجابة JSON
const data = res.getBody(true);
tests['User ID exists'] = data.user && data.user.id > 0;

// وقت الاستجابة
tests['Response time < 500ms'] = res.getResponseTime() < 500;

// تحقق من الرأس
tests['Content-Type is JSON'] = res.getHeader('content-type').includes('application/json');

مثال اختبار معقد

const data = res.getBody(true);

tests['Status is 201'] = res.getStatus() === 201;
tests['ID is a number'] = typeof data.id === 'number';
tests['Email is valid'] = /^[\w-\.]+@([\w-]+\.)+[\w-]{2,4}$/.test(data.email);
tests['Created at is ISO date'] = !isNaN(Date.parse(data.createdAt));

// حفظ للطلب التالي
if (tests['Status is 201']) {
  bru.setEnvVar('newUserId', data.id);
}

المصادقة

رمز Bearer

auth:bearer {
  token: {{authToken}}
}

المصادقة الأساسية

auth:basic {
  username: {{username}}
  password: {{password}}
}

API Key (الرأس)

headers {
  X-API-Key: {{apiKey}}
  Authorization: ApiKey {{apiKey}}
}

API Key (معامل الاستعلام)

params:query {
  api_key: {{apiKey}}
  apiToken: {{token}}
}

OAuth 2.0

auth:oauth2 {
  grant_type: authorization_code
  authorization_url: https://provider.com/oauth/authorize
  token_url: https://provider.com/oauth/token
  client_id: {{clientId}}
  client_secret: {{clientSecret}}
  scope: read write
}

المصادقة Digest

auth:digest {
  username: {{username}}
  password: {{password}}
}

أنواع الطلبات والطرق

طلب GET

meta {
  name: Fetch User
  type: http
  seq: 1
}

get {
  url: {{baseUrl}}/api/users/{{userId}}
}

params:query {
  includeProfile: true
  fields: id,name,email
}

طلب POST

post {
  url: {{baseUrl}}/api/users
}

body:json {
  {
    "name": "Jane Doe",
    "email": "jane@example.com"
  }
}

طلب PUT/PATCH

put {
  url: {{baseUrl}}/api/users/{{userId}}
}

body:json {
  {
    "name": "Jane Smith",
    "status": "active"
  }
}

طلب DELETE

delete {
  url: {{baseUrl}}/api/users/{{userId}}
}

طلب مع الرؤوس

headers {
  Content-Type: application/json
  Accept: application/json
  User-Agent: Bruno/v1.0
  X-Request-ID: {{requestId}}
  Authorization: Bearer {{token}}
}

الميزات المتقدمة

متغيرات على مستوى المجموعة

حدد المتغيرات في bruno.json:

{
  "name": "My API Collection",
  "version": "1.0",
  "variables": {
    "baseUrl": "https://api.example.com",
    "version": "v1",
    "defaultTimeout": 5000
  }
}

تسلسل الطلبات

التحكم في ترتيب تنفيذ الطلبات في عداء CLI:

meta {
  name: Authenticate
  type: http
  seq: 1
}
meta {
  name: Get User Data
  type: http
  seq: 2
}

يتم تنفيذ الطلبات بترتيب seq.

استعلامات GraphQL

meta {
  name: GraphQL Query
  type: http
  seq: 1
}

post {
  url: {{baseUrl}}/graphql
}

body:graphql {
  query {
    user(id: "{{userId}}") {
      id
      name
      email
    }
  }
}

معاملات الاستعلام

params:query {
  page: 1
  limit: 10
  sort: -createdAt
  filter: status:active
}

سير عمل Git

لماذا يهم Git-Native

# المجموعات المخزنة كملفات نصية
.bru/
├── users/
│   ├── get-user.bru
│   └── create-user.bru
└── products/
    └── list-products.bru

# سهل للتحكم في الإصدار
git add .
git commit -m "Update API requests"
git push origin main

# تضارب الدمج قابل للإدارة
# مراجعة التغييرات في PRs
# التعاون مع الفريق

سير عمل التعاون

# عضو الفريق يستنسخ المجموعة
git clone https://github.com/team/api-collection.git
cd api-collection

# تثبيت CLI Bruno
npm install -g @usebruno/cli

# تشغيل الاختبارات محليًا
bru run . --env Development

# إجراء التغييرات
# إضافة طلبات جديدة أو تحديث الطلبات الموجودة

# الالتزام والدفع
git add .
git commit -m "Add payment API endpoints"
git push origin feature/payments

تجاهل الملفات الحساسة

# .gitignore في جذر المجموعة
.env
.env.local
environments/Production.json
!environments/Production.json.example
secrets/
node_modules/

تكامل CI/CD

GitHub Actions

name: API Tests

on: [push, pull_request]

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3

      - name: Install Node.js
        uses: actions/setup-node@v3
        with:
          node-version: '18'

      - name: Install Bruno CLI
        run: npm install -g @usebruno/cli

      - name: Run API tests
        run: bru run . --env CI --reporter json --output test-results.json

      - name: Upload results
        if: always()
        uses: actions/upload-artifact@v3
        with:
          name: test-results
          path: test-results.json

GitLab CI

api-tests:
  image: node:18
  script:
    - npm install -g @usebruno/cli
    - bru run . --env CI --reporter json --output test-results.json
  artifacts:
    paths:
      - test-results.json
    reports:
      junit: test-results.json

خطاف Pre-commit المحلي

#!/bin/bash
# .git/hooks/pre-commit

echo "Running API tests..."
bru run . --env Development --failOnError

if [ $? -ne 0 ]; then
  echo "API tests failed. Commit aborted."
  exit 1
fi

سير العمل الشائع

اختبار REST API

# 1. إعداد البيئة
bru run /path/to/collection --env Development

# 2. التحقق من نتائج الاختبار
# نتائج الاختبارات معروضة في الإخراج

# 3. إنشاء تقرير
bru run /path/to/collection --env Development --reporter html --output report.html

اختبار الحمل مع الطلبات المتوازية

// في سكريبت ما قبل الطلب
for (let i = 0; i < 10; i++) {
  bru.setEnvVar('iteration', i);
}

توليد البيانات الديناميكية

// إنشاء بريد إلكتروني فريد لكل طلب
const timestamp = Date.now();
bru.setEnvVar('dynamicEmail', `user_${timestamp}@example.com`);

// توليد معرف عشوائي
bru.setEnvVar('randomId', Math.floor(Math.random() * 10000));

ربط الطلبات

// في نص ما بعد الاستجابة للطلب الأول
const data = res.getBody(true);
bru.setEnvVar('userId', data.id);
// الطلب التالي يستخدم {{userId}}

التصحيح

تفعيل الوضع التفصيلي

bru run /path/to/collection --verbose

عرض تفاصيل الطلب/الاستجابة

في واجهة Bruno:

  • انقر على الطلب
  • عرض علامة “معاملات” لمعاملات الاستعلام
  • عرض علامة “نص” لنص الطلب
  • عرض علامة “الاستجابة” لبيانات الاستجابة
  • عرض علامة “الاختبارات” لنتائج الاختبار

تسجيل وحدة التحكم

// في نصوص ما قبل الطلب أو ما بعد الاستجابة
console.log('Variable value:', bru.getEnvVar('baseUrl'));
console.log('Full response:', res.getBody());
console.log('Status code:', res.getStatus());

فحص الشبكة

// التحقق من رؤوس الاستجابة
const headers = res.getHeaders();
console.log('All headers:', headers);

// التحقق من وقت الاستجابة
console.log('Response time:', res.getResponseTime(), 'ms');

أفضل ممارسات هيكل الملف

api-collection/
├── README.md                 # الوثائق
├── .gitignore               # تجاهل الملفات الحساسة
├── bruno.json               # بيانات المجموعة الوصفية
├── environments/            # ملفات البيئة
│   ├── Development.json
│   ├── Staging.json
│   └── Production.json
├── globals.json             # متغيرات عامة
├── auth/
│   ├── login.bru
│   └── refresh-token.bru
├── users/
│   ├── get-all-users.bru
│   ├── get-user-by-id.bru
│   ├── create-user.bru
│   ├── update-user.bru
│   └── delete-user.bru
├── products/
│   ├── list-products.bru
│   └── get-product.bru
└── scripts/
    ├── test-runner.js
    └── helpers.js

الموارد

الموردالرابط
الموقع الرسميusebruno.com
مستودع GitHubgithub.com/usebruno/bruno
الوثائقdocs.usebruno.com
تحميلusebruno.com/downloads
مجتمع Discorddiscord.gg/usebruno
مواصفات لغة Brugithub.com/usebruno/bru
دليل اختبار APIdocs.usebruno.com/api-testing
مشاكل GitHubgithub.com/usebruno/bruno/issues

نصائح وحيل

  • Git Diff للمراجعات: نظرًا لأن المجموعات عبارة عن ملفات، استخدم git diff لمراجعة تغييرات API قبل الدمج
  • قوالب البيئة: قم بإنشاء ملفات .example.json للبيئات لمشاركة هيكل التكوين بدون أسرار
  • النصوص القابلة لإعادة الاستخدام: قم بتخزين نصوص الاختبار الشائعة في ملفات .js منفصلة والرجوع إليها
  • نطاق المتغيرات: تنطبق متغيرات المجموعة بشكل عام؛ متغيرات على مستوى الطلب تتجاوزها
  • الأداء: استخدم علامة --failOnError في CI/CD لاكتشاف فشل الاختبار مبكرًا
  • الوثائق: أضف تعليقات في ملفات .bru باستخدام // comment syntax
  • الإصدار: قم بتضمين إصدار API في متغير عنوان URL الأساسي للتبديل السهل بين الإصدارات