¿Esto es compatible con Swagger 2.0?

Sí. El generador es compatible con el formato Swagger 2.0 más antiguo y con las especificaciones modernas OpenAPI 3.x.

¿Se carga mi especificación de API a un servidor?

No. El análisis y la generación de código se realizan localmente en la sesión de tu navegador usando JavaScript. Tus endpoints y esquemas de API internos nunca salen de tu máquina.

¿Qué dependencias se requieren para la salida?

El código generado requiere que `axios` y `typescript` estén instalados en tu proyecto. Utiliza los patrones estándar de Axios para solicitudes e interceptores.

¿Puedo usar la salida en un proyecto de JavaScript puro?

Aunque la salida es TypeScript, puedes eliminar las anotaciones de tipo para usarla como un "wrapper" estándar de Axios. Sin embargo, está diseñada principalmente para proporcionar seguridad de tipos en IDEs como VS Code.

Formateadores y código

OpenAPI → Cliente 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

Nota del editor

Understanding · Turn the contract into a typed client.

Este capítulo en profundidad está disponible solo en inglés por el momento. La herramienta de conversión de arriba funciona en tu idioma; el artículo explicativo extenso aún no se ha traducido.

Preguntas frecuentes

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.

La gente también busca

Herramientas relacionadas

More in this room.

Ver todo en Formateadores y código