api html

API-HTML

Konvertieren Sie jede API-Spezifikation in eine beeindruckende HTML-Dokumentations-Website

Screenshot

Nutzen Sie das Online-Tool

API-HTML

Verwenden Sie CLI

Installation

npm i api-html -g

Verwendung

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

Demo

Der obige Befehl konvertiert die angegebene url in eine statische Website im aktuellen Verzeichnis mit dem Namen dist -Verzeichnis.

Es besteht auch die Möglichkeit, eine file anstelle einer url zu übergeben.

Parameter

Param	Kurz	Erforderlich	Standardwert	Details
--file	-f	required	null	Gleichzeitig ist der Pfad zu einer lokalen Quelldatei, --file oder --url on erforderlich.
--url	-u	required	null	Gleichzeitig ist eine URL zu einer Online-Quelldatei, --file oder --url on erforderlich.
--type	-t	optional	swagger	Codierter Typ der API-Spezifikation, wie swagger , openapi , api_blueprint , io_docs , google , raml oder wadl
--version	-v	optional	2	Version der OpenAPI ( swagger ), mögliche Werte sind 1, 2 oder 3. Gilt nur für swagger
--yaml	-y	optional	0	Wenn der Quelldateityp yaml ist, sollte der Wert 1 sein und gilt nur für swagger
--option	-o	optional	./options.json	Pfad zur Optionsdatei, siehe Details unten

Beispiel

  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

Optionen (options.json)

Die Optionen sollten sich in einer JSON-Datei befinden. Wenn Sie den Parameter --option nicht übergeben, prüfen wir das aktuelle Verzeichnis mit dem Namen options.json .

Name	Standardwert	Beschreibung
theme	compact	Legen Sie das UI-Design fest. Die Werte sind: „kompakt“ und „einfach“.
baseColor	#6e9a04	Legen Sie die Grundfarbe des Themas fest
textColor	#FFF	Legen Sie die Textfarbe des Themas fest
logo	'swagger-logo'	Verweisen Sie ein Logo auf eine lokale Datei
logoUrl	''	Verweisen Sie mit einem Logo auf die URL
isCoding	true	Den Codierungsabschnitt in der Anfrage ein- oder ausblenden
isSearch	true	Suchfunktion ein- oder ausblenden
isTryRequest	true	Zeigen Sie die Schaltfläche „Ausprobieren“ in der Anfrage an oder verbergen Sie sie
isBackToTopButton	true	Blenden Sie die Schaltfläche BackToTop ein oder aus
isCreditLink	true	Blenden Sie den Credit Link unterhalb der Navigationsleiste ein oder aus
pageTitle	der title aus der Datei swagger.json	Legen Sie den Seitentitel fest, der in der Titelleiste des Browsers angezeigt wird.
customHeadScript	''	Fügen Sie dem Head-Tag ein benutzerdefiniertes Skript hinzu
customFootScript	''	Fügen Sie dem Fuß-Tag ein benutzerdefiniertes Skript hinzu
pageTags	''	Stellen Sie die Meta-Schlüsselwörter der Seite dar. Jedes Schlüsselwort sollte durch ein Komma getrennt werden. Meta-Keywords sind hilfreich für die Seiten-SEO.
pageDescription	''	Stellt die Meta-Beschreibung der Seite dar
apiVersions	''	Geben Sie API-Versionen im folgenden Format ein: (Name)[URL] (Name)[URL] ... Exp: (V1)[https://zamacall.io/docs/v1/] (V2)[https://zamacall.io/docs/v2/]
headerMenuItems	''	Geben Sie die Menüelemente der Kopfzeile im folgenden Format ein: (Name)[URL] (Name)[URL] ... Exp: (Hauptwebsite)[https://zamacall.io] (Kontaktieren Sie uns)[https://zamacall.io/contact/]

Beispiel

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

Änderungsprotokoll

• Ein neues kompaktes UI-Design hinzugefügt; Schön, sauber, schneller und leicht.
• Unterstützung für IO Docs Quelldatei hinzugefügt
• Unterstützung für WADL Quelldatei hinzugefügt
• Unterstützung für RAML Quelldatei hinzugefügt
• Unterstützung für Google API Descory -Quelldatei hinzugefügt
• Unterstützung für API Blueprint Quelldatei hinzugefügt
• Unterstützung für YAML Quelldatei hinzugefügt
• Unterstützung für OpenAPI (Swagger) Version 1, 2 und 3 hinzugefügt.
• Suchfunktion hinzugefügt
• Unterstützung für das Ausprobieren der API-Anfrage hinzugefügt
• Unterstützung für die Codegenerierung für Sprachen wie cURL , Node , Python und JavaScript hinzugefügt
• Ein Online-Tool zur Vorschau und zum Herunterladen über die Online-Website hinzugefügt
• Den Authentifizierungsabschnitten wurde eine automatische Beschreibung hinzugefügt, die die leeren Beschreibungen ersetzt.
• Unterstützung für kleine Bildschirme wie Mobilgeräte hinzugefügt

Melden Sie ein Problem oder fordern Sie eine Funktion an

Github-Probleme

Kontaktieren Sie uns

[email protected]