Поддерживает ли это Swagger 2.0?

Да. Генератор поддерживает как старый формат Swagger 2.0, так и современные спецификации OpenAPI 3.x.

Загружается ли моя спецификация API на сервер?

Нет. Анализ и генерация кода происходят локально в вашей сессии браузера с использованием JavaScript. Ваши внутренние конечные точки API и схемы никогда не покидают ваш компьютер.

Какие зависимости необходимы для вывода?

Для сгенерированного кода требуется установка `axios` и `typescript` в вашем проекте. Он использует стандартные шаблоны Axios для запросов и перехватчиков.

Могу ли я использовать вывод в простом проекте JavaScript?

Хотя вывод является TypeScript, вы можете удалить аннотации типов, чтобы использовать его как стандартный обертку Axios. Однако он в первую очередь разработан для обеспечения безопасности типов в IDE, таких как VS Code.

Форматтеры и код

OpenAPI → Axios-клиент TypeScript

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.

Смотреть все в Форматтеры и код