Questo supporta Swagger 2.0?

Sì. Il generatore supporta sia il formato Swagger 2.0 più vecchio che le specifiche moderne OpenAPI 3.x.

La mia specifica API viene caricata su un server?

No. L'analisi e la generazione del codice avvengono localmente nella sessione del browser utilizzando JavaScript. Gli endpoint e gli schemi API interni non lasciano mai la tua macchina.

Quali dipendenze sono richieste per l'output?

Il codice generato richiede che `axios` e `typescript` siano installati nel progetto. Utilizza i modelli Axios standard per le richieste e gli intercettori.

Posso usare l'output in un progetto JavaScript puro?

Sebbene l'output sia TypeScript, è possibile rimuovere le annotazioni di tipo per usarlo come wrapper Axios standard. Tuttavia, è principalmente progettato per fornire sicurezza dei tipi in IDE come VS Code.

Formattatori e Codice

OpenAPI → Client 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 dell'editore

Understanding · Turn the contract into a typed client.

Questo capitolo approfondito è attualmente disponibile solo in inglese. Lo strumento di conversione qui sopra funziona nella tua lingua; il lungo articolo esplicativo non è stato ancora tradotto.

Domande frequenti

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.

Le persone cercano anche

Strumenti correlati

More in this room.

Vedi tutto in Formattatori e Codice