api html

API HTML

Convertissez n'importe quelle spécification d'API en un superbe site Web de documentation HTML

Capture d'écran

Utiliser l'outil en ligne

API HTML

Utiliser la CLI

Installation

npm i api-html -g

Usage

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

Démo

La commande ci-dessus convertira l' url donnée en un site Web statique dans le répertoire actuel avec le nom du répertoire dist .

Il existe également la possibilité de transmettre un file au lieu d' url .

Paramètres

Paramètre	Court	Requis	Valeur par défaut	Détails
--file	-f	required	nul	Le chemin d'accès à un fichier source local, --file ou --url on est requis en même temps.
--url	-u	required	nul	L'URL d'un fichier source en ligne, --file ou --url on est requise en même temps.
--type	-t	facultatif	swagger	Type codé de la spécification de l'API, comme swagger , openapi , api_blueprint , io_docs , google , raml ou wadl
--version	-v	facultatif	2	Version de l'OpenAPI ( swagger ), les valeurs possibles sont 1, 2 ou 3. Applicable uniquement à swagger
--yaml	-y	facultatif	0	Si le type de fichier source est yaml alors la valeur doit être 1 , applicable uniquement à swagger
--option	-o	facultatif	./options.json	Chemin d'accès au fichier d'options, voir les détails ci-dessous

Exemple

  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

Options (options.json)

Les options doivent être dans un fichier json. Si vous ne transmettez pas le paramètre --option , nous vérifierons dans le répertoire courant avec le nom options.json .

Nom	Valeur par défaut	Description
theme	compact	Définissez le thème de l'interface utilisateur, les valeurs sont : "compact" et "basic".
baseColor	#6e9a04	Définir la couleur de base du thème
textColor	#FFF	Définir la couleur du texte du thème
logo	'logo-swagger'	Pointer un logo vers un fichier local
logoUrl	''	Pointez un logo vers l'URL
isCoding	true	Afficher ou masquer la section de codage dans la demande
isSearch	true	Afficher ou masquer la fonction de recherche
isTryRequest	true	Afficher ou masquer le bouton "essayer" dans la demande
isBackToTopButton	true	Masquer ou afficher le bouton BackToTop
isCreditLink	true	Masquer ou afficher le lien Credit sous la barre de navigation
pageTitle	le title du fichier swagger.json	Définissez le titre de la page affiché dans la barre de titre du navigateur.
customHeadScript	''	Ajouter un script personnalisé à la balise head
customFootScript	''	Ajouter un script personnalisé à la balise foot
pageTags	''	Représente les méta-mots-clés de la page, chaque mot-clé doit être séparé par une virgule. Les méta-mots-clés sont utiles pour le référencement de la page.
pageDescription	''	Représenter la méta description de la page
apiVersions	''	Versions de l'API, saisissez-les au format suivant : (Nom)[URL] (Nom)[URL] ... Expérience : (V1)[https://zamacall.io/docs/v1/] (V2)[https://zamacall.io/docs/v2/]
headerMenuItems	''	Éléments du menu d'en-tête, saisissez-les au format suivant : (Nom)[URL] (Nom)[URL] ... Expérience : (Site Web principal)[https://zamacall.io] (Contactez-nous)[https://zamacall.io/contact/]

Exemple

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

Journal des modifications

• Ajout d'un nouveau thème d'interface utilisateur compact ; Agréable, propre, plus rapide et léger.
• Ajout de la prise en charge du fichier source IO Docs
• Ajout de la prise en charge du fichier source WADL
• Ajout de la prise en charge du fichier source RAML
• Ajout de la prise en charge du fichier source Google API Descory
• Ajout de la prise en charge du fichier source API Blueprint
• Ajout de la prise en charge du fichier source YAML
• Ajout de la prise en charge d' OpenAPI (swagger) versions 1, 2 et 3.
• Ajout de la fonctionnalité de recherche
• Ajout de la prise en charge pour essayer la requête API
• Ajout de la prise en charge de la génération de code pour des langages tels que : cURL , Node , Python et JavaScript
• Ajout d'un outil en ligne pour prévisualiser et télécharger via le site Web en ligne
• Ajout d'une description automatique aux sections Authentification, remplacera les descriptions vides.
• Ajout de la prise en charge des petits écrans comme les appareils mobiles

Signaler un problème ou demander une fonctionnalité

Problèmes avec GitHub

Contactez-nous

[email protected]