هل يدعم هذا Swagger 2.0؟

نعم. يدعم المُولد كلاً من تنسيق Swagger 2.0 الأقدم ومواصفات OpenAPI 3.x الحديثة.

هل يتم تحميل مواصفات API الخاصة بي إلى خادم؟

لا. يتم تحليل وإنشاء الكود محليًا في جلسة المتصفح الخاصة بك باستخدام JavaScript. لا تغادر نقاط نهاية ومخططات API الداخلية الخاصة بك جهازك أبدًا.

ما هي التبعيات المطلوبة للإخراج؟

يتطلب الكود الذي تم إنشاؤه تثبيت `axios` و `typescript` في مشروعك. يستخدم أنماط Axios القياسية للطلبات والمعترضات.

هل يمكنني استخدام الإخراج في مشروع JavaScript عادي؟

بينما يكون الإخراج TypeScript، يمكنك إزالة تعليقات النوع لاستخدامه كغلاف Axios قياسي. ومع ذلك، فهو مصمم بشكل أساسي لتوفير أمان النوع في بيئات التطوير المتكاملة مثل VS Code.

المنسقات والكود

OpenAPI → عميل TypeScript Axios

Generate a typed Axios client from any OpenAPI spec.

Runs in your browser

OpenAPI spec (YAML or JSON) · source

lines: 42chars: 924size: 924 B

TypeScript Axios client · 2 operation(s) · result

import axios from "axios";

export const api = axios.create({
  baseURL: process.env.NEXT_PUBLIC_API_URL ?? "/api",
  headers: { "Content-Type": "application/json" },
});

export async function getTools() {
  const res = await api.get<unknown>(`/tools`);
  return res.data;
}

export async function getToolsSlug(slug: string) {
  const res = await api.get<unknown>(`/tools/${slug}`);
  return res.data;
}

lines: 16chars: 404size: 404 B

live

ملاحظة المحرر

Understanding · Turn the contract into a typed client.

هذا الفصل المعمّق متاح حاليًا باللغة الإنجليزية فقط. أداة التحويل أعلاه تعمل بلغتك؛ أما المقال التفصيلي الطويل فلم تتم ترجمته بعد.

الأسئلة المتكررة

Quick answers.

›Does this support Swagger 2.0?

Yes. The generator supports both the older Swagger 2.0 format and the modern OpenAPI 3.x specifications.

›Is my API specification uploaded to a server?

No. The parsing and code generation happen locally in your browser session using JavaScript. Your internal API endpoints and schemas never leave your machine.

›What dependencies are required for the output?

The generated code requires `axios` and `typescript` to be installed in your project. It uses standard Axios patterns for requests and interceptors.

›Can I use the output in a plain JavaScript project?

While the output is TypeScript, you can strip the type annotations to use it as a standard Axios wrapper. However, it is primarily designed to provide type safety in IDEs like VS Code.

يبحث الأشخاص أيضًا عن

أدوات ذات صلة

More in this room.

شاهد الكل في المنسقات والكود