Isto suporta Swagger 2.0?

Sim. O gerador suporta ambos os formatos antigos Swagger 2.0 e as especificações modernas OpenAPI 3.x.

A minha especificação de API é carregada para um servidor?

Não. A análise e a geração de código acontecem localmente na sua sessão do navegador usando JavaScript. Os seus endpoints e esquemas de API internos nunca saem da sua máquina.

Quais dependências são necessárias para a saída?

O código gerado requer que o `axios` e o `typescript` estejam instalados no seu projeto. Ele usa padrões Axios standard para pedidos e interceptores.

Posso usar a saída num projeto JavaScript puro?

Embora a saída seja TypeScript, pode remover as anotações de tipo para usá-lo como um wrapper Axios padrão. No entanto, foi projetado principalmente para fornecer segurança de tipo em IDEs como o VS Code.

Formatadores e Código

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

Nota do editor

Understanding · Turn the contract into a typed client.

Este capítulo aprofundado está disponível apenas em inglês no momento. A ferramenta de conversão acima funciona no seu idioma; o artigo explicativo longo ainda não foi traduzido.

Perguntas frequentes

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.

As pessoas também pesquisam por

Ferramentas relacionadas

More in this room.

Ver tudo em Formatadores e Código