Загрузка api html - Загрузка исходного кода api html

api html

Другие категории

1.0.0

Скачать

API HTML

Преобразуйте любую спецификацию API в потрясающий веб-сайт с документацией HTML.

Скриншот

Используйте онлайн-инструмент

API HTML

Используйте интерфейс командной строки

Установка

npm i api-html -g

Использование

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

Демо

Приведенная выше команда преобразует данный url в статический веб-сайт в текущем каталоге с именем каталога dist .

Также есть возможность передать file вместо url .

Параметры

Парам	Короткий	Необходимый	Значение по умолчанию	Подробности
`--file`	`-f`	`required`	нулевой	Одновременно требуется указать путь к локальному исходному файлу, `--file` или `--url` on.
`--url`	`-u`	`required`	нулевой	Одновременно требуется URL-адрес исходного файла в Интернете, `--file` или `--url` on.
`--type`	`-t`	необязательный	`swagger`	Закодированный тип спецификации API, например `swagger` , `openapi` , `api_blueprint` , `io_docs` , `google` , `raml` или `wadl`
`--version`	`-v`	необязательный	`2`	Версия OpenAPI ( `swagger` ), возможные значения: 1, 2 или 3. Применимо только к `swagger`
`--yaml`	`-y`	необязательный	`0`	Если тип исходного файла — `yaml` , значение должно быть `1` , применимо только к `swagger`
`--option`	`-o`	необязательный	`./options.json`	Путь к файлу настроек, подробности см. ниже.

Пример

  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.json)

Параметры должны быть в файле json. Если вы не передадите параметр --option , мы проверим текущий каталог с именем options.json .

Имя	Значение по умолчанию	Описание
`theme`	`compact`	Установите тему пользовательского интерфейса, значения: «компактный» и «базовый».
`baseColor`	`#6e9a04`	Установите базовый цвет темы
`textColor`	`#FFF`	Установите цвет текста темы
`logo`	'чванливый логотип'	Наведите логотип на локальный файл
`logoUrl`	''	Наведите логотип на URL-адрес
`isCoding`	`true`	Показать или скрыть раздел кодирования в запросе
`isSearch`	`true`	Показать или скрыть функцию поиска
`isTryRequest`	`true`	Показать или скрыть кнопку «Попробовать» в запросе
`isBackToTopButton`	`true`	Скрыть или показать кнопку `BackToTop`
`isCreditLink`	`true`	Скрыть или показать ссылку `Credit` под панелью навигации.
`pageTitle`	`title` из файла `swagger.json`	Установите заголовок страницы, отображаемый в строке заголовка браузера.
`customHeadScript`	''	Добавьте собственный скрипт в тег head
`customFootScript`	''	Добавьте собственный скрипт в тег ноги
`pageTags`	''	Представляйте мета-ключевые слова страницы. Каждое ключевое слово должно быть разделено запятой. Мета-ключевые слова полезны для SEO страницы.
`pageDescription`	''	Представлять метаописание страницы
`apiVersions`	''	Версии API введите в следующем формате: (Имя)[URL] (Имя)[URL] ... Опыт: (В1)[https://zamacall.io/docs/v1/] (В2)[https://zamacall.io/docs/v2/]
`headerMenuItems`	''	Пункты меню заголовка введите в следующем формате: (Имя)[URL] (Имя)[URL] ... Опыт: (Основной сайт)[https://zamacall.io] (Свяжитесь с нами)[https://zamacall.io/contact/]

Пример

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

Журнал изменений

Добавлена новая компактная тема пользовательского интерфейса; Хороший, чистый, быстрый и легкий.
Добавлена поддержка исходного файла IO Docs
Добавлена поддержка исходного файла WADL
Добавлена поддержка исходного файла RAML
Добавлена поддержка исходного файла Google API Descory .
Добавлена поддержка исходного файла API Blueprint .
Добавлена поддержка исходного файла YAML
Добавлена поддержка OpenAPI (swagger) версий 1, 2 и 3.
Добавлена функция поиска
Добавлена поддержка попытки запроса API.
Добавлена поддержка генерации кода для таких языков, как: cURL , Node , Python и JavaScript
Добавлен онлайн-инструмент для предварительного просмотра и загрузки через онлайн-сайт.
В разделы Аутентификация добавлено автоматическое описание, заменит пустые описания.
Добавлена поддержка маленьких экранов, например мобильных устройств.