Czy to obsługuje Swagger 2.0?

Tak. Generator obsługuje zarówno starszy format Swagger 2.0, jak i nowoczesne specyfikacje OpenAPI 3.x.

Czy moja specyfikacja API jest przesyłana na serwer?

Nie. Parsowanie i generowanie kodu odbywa się lokalnie w Twojej sesji przeglądarki za pomocą JavaScript. Twoje wewnętrzne punkty końcowe API i schematy nigdy nie opuszczają Twojej maszyny.

Jakie zależności są wymagane dla wyniku?

Wygenerowany kod wymaga zainstalowania `axios` i `typescript` w Twoim projekcie. Wykorzystuje standardowe wzorce Axios dla żądań i interceptorów.

Czy mogę używać wyniku w "zwykłym" projekcie JavaScript?

Chociaż wyjście jest TypeScriptem, możesz usunąć adnotacje typów, aby używać go jako standardowego wrapera Axios. Jednakże, jego głównym celem jest zapewnienie bezpieczeństwa typów w IDE, takich jak VS Code.

Formatowanie i Kodowanie

OpenAPI → Klient TypeScript Axios

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

Notka redakcyjna

Understanding · Turn the contract into a typed client.

Ten szczegółowy rozdział jest obecnie dostępny tylko w języku angielskim. Narzędzie konwersji powyżej działa w Twoim języku; długi artykuł objaśniający nie został jeszcze przetłumaczony.

Często zadawane pytania

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.

Ludzie wyszukują również

Powiązane narzędzia

More in this room.

Zobacz wszystkie w Formatowanie i Kodowanie