📋 محتويات الصفحة
📖 الوصف
OpenAPI (سابقاً Swagger Specification) هو معيار صناعي لوصف REST APIs. يتم استخدامه لتصميم، بناء، توثيق، واختبار APIs بطريقة معيارية. OpenAPI 3.0 يدعم JSON, YAML, والـ servers المتعددة، وهو المعيار المستخدم حالياً.
🎯 يستخدم في
مجالات استخدام هذه الأداة
•
مواصفات API
•
API design-first
•
توليد SDKs و Clients
•
API Documentation
•
Contract Testing
•
Mock Servers
✨ المميزات
أبرز مميزات هذه الأداة
✓
المعيار الصناعي
✓
دعم JSON و YAML
✓
servers متعددة
✓
security schemes
✓
callbacks و webhooks
✓
tools غنية (editors
✓
generators
✓
UI)
✓
versioning مدعوم
⚠️ العيوب
نقاط يجب مراعاتها
×
spec طويل ومعقد
×
يحتاج معرفة بالمعيار
×
بعض الميزات غير مدعومة في بعض الأدوات
💻 مثال على الاستخدام
كيفية استخدام هذه الأداة
# openapi.yaml (OpenAPI 3.1)
openapi: 3.1.0
info:
title: Bookstore API
version: 2.0.0
description: A complete bookstore API
contact:
name: API Support
email: support@example.com
servers:
- url: https://api.bookstore.com/v2
description: Production
- url: https://staging-api.bookstore.com/v2
description: Staging
paths:
/books:
get:
summary: List all books
parameters:
- name: genre
in: query
schema:
type: string
- name: page
in: query
schema:
type: integer
default: 1
responses:
'200':
description: List of books
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Book'
total:
type: integer
components:
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
schemas:
Book:
type: object
properties:
id:
type: integer
title:
type: string
author:
type: string
price:
type: number
required:
- title
- author📚 أدوات أخرى في API
قد يعجبك أيضاً