api html

HTML da API

Converta qualquer especificação de API em um incrível site de documentação HTML

Captura de tela

Use a ferramenta on-line

HTML da API

Usar CLI

Instalação

npm i api-html -g

Uso

api-html --url https://petstore.swagger.io/v2/swagger.json

Demonstração

O comando acima irá converter o url fornecido em um site estático no diretório atual com o nome do diretório dist .

Também existe a possibilidade de passar um file em vez de url .

Parâmetros

Parâmetro	Curto	Obrigatório	Valor padrão	Detalhes
--file	-f	required	nulo	Caminho para um arquivo de origem local, --file ou --url on é necessário ao mesmo tempo.
--url	-u	required	nulo	URL para um arquivo de origem online, --file ou --url on é necessário ao mesmo tempo.
--type	-t	opcional	swagger	Tipo codificado da especificação da API, como swagger , openapi , api_blueprint , io_docs , google , raml ou wadl
--version	-v	opcional	2	Versão do OpenAPI ( swagger ), os valores possíveis são 1, 2 ou 3. Aplicável apenas ao swagger
--yaml	-y	opcional	0	Se o tipo de arquivo de origem for yaml , o valor deverá ser 1 , aplicável apenas ao swagger
--option	-o	opcional	./options.json	Caminho para o arquivo de opções, veja os detalhes abaixo

Exemplo

  api-html --yaml 1 --url https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v2.0/yaml/api-with-examples.yaml
  # A Swagger (OpenAPI) version 2 source file with yaml type

  api-html --version 3 --url https://api.gettyimages.com/swagger/v3/swagger.json
  # A Swagger (OpenAPI) version 3 source file with json type

  api-html --version 3 --yaml 1 --url https://raw.githubusercontent.com/OAI/OpenAPI-Specification/master/examples/v3.0/petstore-expanded.yaml
  # A Swagger (OpenAPI) version 3 source file with yaml type

  api-html --type api_blueprint --url https://raw.githubusercontent.com/apiaryio/api-blueprint/master/examples/Polls%20API.md
  # An API Blueprint source file

  api-html --type google --url https://www.googleapis.com/discovery/v1/apis/translate/v2/rest
  # A Google API descory source file

  api-html --type raml --url https://raw.githubusercontent.com/raml-apis/XKCD/master/api.raml
  # A RAML source file

  api-html --type io_docs --url https://raw.githubusercontent.com/lucybot/api-spec-converter/master/test/input/io_docs/foursquare.json
  # An IO Docs source file

Opções (options.json)

As opções devem estar em um arquivo json. Se você não passar o parâmetro --option então verificaremos o diretório atual com o nome de options.json .

Nome	Valor padrão	Descrição
theme	compact	Defina o tema da UI, os valores são: "compacto" e "básico".
baseColor	#6e9a04	Defina a cor base do tema
textColor	#FFF	Defina a cor do texto do tema
logo	'logotipo arrogante'	Aponte um logotipo para um arquivo local
logoUrl	''	Aponte um logotipo para o URL
isCoding	true	Mostrar ou ocultar a seção de codificação na solicitação
isSearch	true	Mostrar ou ocultar o recurso de pesquisa
isTryRequest	true	Mostrar ou ocultar o botão "experimentar" na solicitação
isBackToTopButton	true	Ocultar ou mostrar o botão BackToTop
isCreditLink	true	Oculte ou mostre o link Credit abaixo da barra de navegação
pageTitle	o title do arquivo swagger.json	Defina o título da página mostrado na barra de título do navegador.
customHeadScript	''	Adicione script personalizado à tag head
customFootScript	''	Adicione script personalizado à tag foot
pageTags	''	Representam as meta palavras-chave da página. Cada palavra-chave deve ser separada por vírgula. Meta palavras-chave são úteis para o SEO da página.
pageDescription	''	Representa a meta descrição da página
apiVersions	''	Versões da API, insira no seguinte formato: (Nome)[URL] (Nome)[URL] ... Exp: (V1)[https://zamacall.io/docs/v1/] (V2)[https://zamacall.io/docs/v2/]
headerMenuItems	''	Itens do menu de cabeçalho, insira no seguinte formato: (Nome)[URL] (Nome)[URL] ... Exp: (Site principal)[https://zamacall.io] (Entre em contato conosco)[https://zamacall.io/contact/]

Exemplo

 {
  "logo": "logo.svg",
  "baseColor": "blue"
} 

Registro de alterações

• Adicionado um novo tema de UI compacto; Agradável, limpo, mais rápido e leve.
• Adicionado suporte para arquivo de origem IO Docs
• Adicionado suporte para arquivo de origem WADL
• Adicionado suporte para arquivo de origem RAML
• Adicionado suporte para arquivo de origem Google API Descory
• Adicionado suporte para arquivo de origem API Blueprint
• Adicionado suporte para arquivo de origem YAML
• Adicionado suporte para OpenAPI (swagger) versões 1, 2 e 3.
• Adicionada a funcionalidade de pesquisa
• Adicionado suporte para tentar a solicitação da API
• Adicionado suporte para geração de código para linguagens como: cURL , Node , Python e JavaScript
• Adicionada uma ferramenta online para visualizar e baixar através do site online
• Adicionada descrição automática às seções de Autenticação, substituirá as descrições vazias.
• Adicionado suporte para telas pequenas, como dispositivos móveis

Relate um problema ou solicite um recurso

Problemas do GitHub

Contate-nos

[email protected]