Autobase Specs 1.0.1 Help

Локальный запуск спецификации внешнего API проекта Autobase

В данной статье рассматривается локальный запуск спецификации публичного API проекта Autobase.

Начало работы

Чтобы начать локальное использование публичной спецификации API проекта Autobase, необходимо клонировать её репозиторий Autobase Specs, для этого:

Клонирование репозитория

  1. Перейдите на официальную страницу репозитория спецификации проекта Autobase

  2. Скачайте репозиторий

    Откройте терминал в нужной вам папке и введите туда эту команду:

    git clone https://github.com/auto-base/specs.git
    1. Нажмите на зеленую кнопку Code

      Зеленая кнопка code
    2. В открывшемся окне нажмите на кнопку Download ZIP

      Окно загрузки

Локальный запуск спецификации

Для запуска в браузере вам необходимо открыть репозиторий, открыть файл pages/index.html в браузере.

Для локального запуска на ОС Windows

Вам также понадобится дополнительно ПО в виде make, установить её на компьютер с ОС Windows можно с помощью CYGWIN.

После чего вы сможете запустить публичную спецификацию внешнего API следующей командой:

make run-swagger

Для локального запуска на ОС Linux

Установите make, используя команду:

apt install make

После чего - выполните эту команду

make run-swagger

Для локального запуска на macOS

Убедитесь, что у вас установлен Homebrew. Если его нет, вы можете установить его, выполнив следующую команду в терминале:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

После установки Homebrew, установите make:

brew install make

Теперь вы можете запустить проект:

make run-swagger
Результат открытия документации

Авторизация

Для авторизации в публичном API проекта Autobase необходимо:

  1. Нажать на зеленую кнопу Authorize

    Зеленая кнопка авторизации в swagger-ui
  2. Ввести свои данные в форму basicAuth (http, Basic)

    Authorize swagger ui basic auth form
  3. Нажать на зеленую кнопу Authorize

    Зеленая кнопка авторизации в swagger-ui

После данных манипуляций вы сможете проводить запросы к публичному API проекта Autobase. Авторизация в публичном API проекта Autobase обеспечивается через метод basic, суть которого заключается в подстановке пары значений логин:пароль.

Last modified: 27 March 2025