Supporte-t-il Swagger 2.0?

Oui. Le générateur prend en charge l'ancien format Swagger 2.0 et les spécifications modernes OpenAPI 3.x.

Ma spécification API est-elle téléchargée sur un serveur?

Non. L'analyse et la génération de code se déroulent localement dans votre session de navigateur à l'aide de JavaScript. Vos points de terminaison et schémas API internes ne quittent jamais votre machine.

Quelles dépendances sont requises pour la sortie?

Le code généré nécessite que `axios` et `typescript` soient installés dans votre projet. Il utilise des modèles Axios standards pour les requêtes et les intercepteurs.

Puis-je utiliser la sortie dans un projet JavaScript simple?

Bien que la sortie soit TypeScript, vous pouvez supprimer les annotations de type pour l'utiliser comme un wrapper Axios standard. Cependant, il est principalement conçu pour fournir une sécurité de type dans les IDE comme VS Code.

Formateurs & Code

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

Note de la rédaction

Understanding · Turn the contract into a typed client.

Ce chapitre approfondi n'est actuellement disponible qu'en anglais. L'outil de conversion ci-dessus fonctionne dans votre langue ; le long article explicatif n'a pas encore été traduit.

Questions fréquentes

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.

Les internautes recherchent aussi

Outils similaires

More in this room.

Tout voir dans Formateurs & Code