api html

HTML API

Convierta cualquier especificación API en un increíble sitio web de documentación HTML

Captura de pantalla

Utilice la herramienta en línea

HTML API

Usar CLI

Instalación

npm i api-html -g

Uso

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

Manifestación

El comando anterior convertirá la url proporcionada en un sitio web estático en el directorio actual con el nombre del directorio dist .

También existe la posibilidad de pasar un file en lugar de url .

parámetros

parámetro	Corto	Requerido	Valor predeterminado	Detalles
--file	-f	required	nulo	Se requiere la ruta a un archivo fuente local, --file o --url al mismo tiempo.
--url	-u	required	nulo	Se requiere la URL de un archivo fuente en línea, --file o --url on al mismo tiempo.
--type	-t	opcional	swagger	Tipo codificado de la especificación API, como swagger , openapi , api_blueprint , io_docs , google , raml o wadl
--version	-v	opcional	2	Versión de OpenAPI ( swagger ), los valores posibles son 1, 2 o 3. Solo aplicable a swagger
--yaml	-y	opcional	0	Si el tipo de archivo fuente es yaml , entonces el valor debe ser 1 , solo aplicable a swagger
--option	-o	opcional	./options.json	Ruta al archivo de opciones, consulte los detalles a continuación

Ejemplo

  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

Opciones (opciones.json)

Las opciones deben estar en un archivo json. Si no pasa el parámetro --option , verificaremos el directorio actual con el nombre de options.json .

Nombre	Valor predeterminado	Descripción
theme	compact	Establezca el tema de la interfaz de usuario, los valores son: "compacto" y "básico".
baseColor	#6e9a04	Establecer el color base del tema.
textColor	#FFF	Establecer el color del texto del tema.
logo	'logotipo de arrogancia'	Apuntar un logotipo a un archivo local
logoUrl	''	Apunte un logotipo a la URL
isCoding	true	Mostrar u ocultar la sección de codificación en la solicitud
isSearch	true	Mostrar u ocultar la función de búsqueda
isTryRequest	true	Mostrar u ocultar el botón "probar" en la solicitud
isBackToTopButton	true	Ocultar o mostrar el botón BackToTop
isCreditLink	true	Ocultar o mostrar el enlace Credit debajo de la barra de navegación
pageTitle	el title del archivo swagger.json	Establezca el título de la página que se muestra en la barra de título del navegador.
customHeadScript	''	Agregar script personalizado a la etiqueta principal
customFootScript	''	Agregar script personalizado a la etiqueta del pie
pageTags	''	Representa las meta palabras clave de la página. Cada palabra clave debe estar separada por una coma. Las meta palabras clave son útiles para el SEO de la página.
pageDescription	''	Representa la meta descripción de la página.
apiVersions	''	Versiones API, ingrese en el siguiente formato: (Nombre)[URL] (Nombre)[URL] ... Exp.: (V1)[https://zamacall.io/docs/v1/] (V2)[https://zamacall.io/docs/v2/]
headerMenuItems	''	Elementos del menú de encabezado, ingréselo en el siguiente formato: (Nombre)[URL] (Nombre)[URL] ... Exp.: (Sitio web principal)[https://zamacall.io] (Contáctenos)[https://zamacall.io/contact/]

Ejemplo

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

Registro de cambios

• Se agregó un nuevo tema de interfaz de usuario compacto; Bonito, limpio, más rápido y ligero.
• Se agregó soporte para el archivo fuente IO Docs
• Se agregó soporte para el archivo fuente WADL
• Se agregó soporte para el archivo fuente RAML
• Se agregó soporte para el archivo fuente Google API Descory
• Se agregó soporte para el archivo fuente API Blueprint
• Se agregó soporte para el archivo fuente YAML
• Se agregó soporte para OpenAPI (swagger) versión 1, 2 y 3.
• Se agregó la función de búsqueda.
• Se agregó soporte para probar la solicitud de API.
• Se agregó soporte para la generación de código para lenguajes como: cURL , Node , Python y JavaScript
• Se agregó una herramienta en línea para obtener una vista previa y descargar a través del sitio web en línea.
• Se agregó una descripción automática a las secciones de Autenticación, reemplazará las descripciones vacías.
• Se agregó soporte para pantallas pequeñas como dispositivos móviles.

Informar un problema o solicitar una función

Problemas de Github

Contáctenos

[email protected]