Orion-API-Manager: API-документ менеджер

QQ-чат: 796665306

Orion-API-Manager (далее — OrionAM) — это API-документ-менеджер, который предоставляет разработчикам API-управление, а также удобный и простой в использовании UI для тестирования. Система интегрирует разрешения, подходящие для использования различными командами в рамках одной организации, поддерживает импорт или отображение документов интерфейса, таких как OpenAPI (Swagger).

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

https://mirren.gitee.io/orion-api-manager-docs

Некоторые ответы

• Вопрос: зачем делать такую вещь?
• Ответ: потому что большинство компаний с разделением на фронтэнд и бэкенд, как и компания автора, требуют сначала иметь документ интерфейса, а затем кодировать.
• Вопрос: что может делать эта вещь? Может ли она генерировать API, как Swagger?
• Ответ: OrionAM не может генерировать API так же, как Swagger, но он поддерживает импорт API, такого как Swagger. OrionAM предназначен для визуализации создания API или просмотра API.
• Вопрос: почему ещё один API-документ-менеджер нужен на рынке, когда уже есть такие инструменты?
• Ответ: в компании автора уже несколько лет используется другой API-документ-менеджер. Разработчики фронтэнда и бэкенда привыкли к нему. Поэтому автор решил обновить и оптимизировать его и сделать открытым исходным кодом. Цель состоит в том, чтобы предоставить программистам, у которых есть аналогичные потребности, ещё один выбор, сделать их жизнь проще и удобнее. Основная цель — объединить API-шлюз, разработанный автором, и сформировать полную систему.

Демонстрация проекта

В настоящее время нет сервера для демонстрации. Автор надеется на вашу поддержку или пожертвования. Вы также можете посмотреть видео в документе об использовании, чтобы увидеть эффект демонстрации.

Структура проекта

• Серверная часть проекта написана на SpringBoot 2.3, что знакомо большинству людей.
• Хранилище по умолчанию использует базу данных Sqlite 3 и поддерживает замену другими базами данных.
• Клиентская часть использует Vue и Element-UI.

Исходный код клиента

Сервер: https://github.com/MirrenTools/Orion-Api-Manager-Server Клиент: https://github.com/MirrenTools/Orion-API-Manager-Client

Как запустить проект

• Требования к среде выполнения: среда разработки — java 1.8.0_121, теоретически можно использовать любую версию java 1.8 и выше. Если у вас нет среды выполнения java, вы можете обратиться к руководству по использованию JDK.
• Проект можно загрузить из releases (релизов) или собрать самостоятельно.
• Для сборки проекта выполните команду mvn clean package.
• После завершения сборки перейдите в каталог target/Orion. Этот каталог содержит Client-UI (интерфейс для отображения документов интерфейса), Server-UI (интерфейс управления документами интерфейса), config (содержит документы интерфейса Sqlite, конфигурацию и информацию о пользователях), Orion-API-Manager.jar.
• В каталоге Orion выполните java -jar Orion-API-Manager.jar или запустите start.bat (Windows) или start.sh (Unix) для запуска службы Orion. По умолчанию порт равен 8686.
• После запуска службы Orion перейдите в браузер и введите адрес службы http://.
• По умолчанию суперпользователь имеет имя X-root и пароль helloOrionAM. Информация о суперпользователе хранится в файле config/user.json.

Инструкция по использованию

• Шаг 1: Запустите Orion-API-Manager.jar (start.bat / start.sh).
• Шаг 2: Перейдите по адресу http://.
• Шаг 3: Создайте пользователя.
• Шаг 4: Создайте проект.
• Шаг 5: Создайте группы и интерфейсы в разделе управления API.
• Шаг 6: Поделитесь или просмотрите в клиенте.