Unterstützt dies Swagger 2.0?

Ja. Der Generator unterstützt sowohl das ältere Swagger 2.0-Format als auch die modernen OpenAPI 3.x-Spezifikationen.

Wird meine API-Spezifikation auf einen Server hochgeladen?

Nein. Das Parsen und die Code-Generierung erfolgen lokal in Ihrer Browser-Sitzung mithilfe von JavaScript. Ihre internen API-Endpunkte und Schemas verlassen niemals Ihr Gerät.

Welche Abhängigkeiten sind für die Ausgabe erforderlich?

Der generierte Code erfordert die Installation von `axios` und `typescript` in Ihrem Projekt. Er verwendet Standard-Axios-Muster für Anfragen und Interceptoren.

Kann ich die Ausgabe in einem reinen JavaScript-Projekt verwenden?

Obwohl die Ausgabe TypeScript ist, können Sie die Typannotationen entfernen, um sie als Standard-Axios-Wrapper zu verwenden. Sie wurde jedoch primär entwickelt, um Typsicherheit in IDEs wie VS Code zu bieten.

Formatierer & Code

OpenAPI → TypeScript Axios Client

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

Anmerkung der Redaktion

Understanding · Turn the contract into a typed client.

Dieses ausführliche Kapitel ist derzeit nur auf Englisch verfügbar. Das Konvertierungstool oben funktioniert in Ihrer Sprache; der lange Erklärtext wurde noch nicht übersetzt.

Häufig gestellte Fragen

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.

Andere suchten auch nach

Verwandte Tools

More in this room.

Alle anzeigen in Formatierer & Code