fusio

О

Fusio — это платформа управления API с открытым исходным кодом, которая помогает создавать инновационные решения API.

Варианты использования

• API-продукт
  Fusio помогает вам создать отличный продукт API. Помимо создания API, он предоставляет портал для разработчиков, где разработчики могут зарегистрироваться, а также способ монетизировать ваш API.
• API-шлюз
  Fusio можно использовать в качестве шлюза к вашему внутреннему API и микросервисам. Он обрабатывает все общие функции, такие как авторизация, ограничение скорости и проверка схемы.
• SPA-бэкенд
  Fusio можно использовать в качестве бэкэнда для создания SPA с использованием популярных Javascript-фреймворков, таких как Angular, React или Vue. Он предоставляет мощный генератор кода, который может автоматически генерировать SDK для вашего API.
• Платформа с низким кодом
  Fusio позволяет создавать конечные точки API без знаний кодирования. Т.е. он предоставляет генератор сущностей, который вы можете использовать для легкого создания полных API-интерфейсов CRUD.
• API-фреймворк
  Для более сложных случаев использования вы также можете использовать Fusio в качестве платформы для создания полноценных API с нуля. Это означает, что вы создаете собственные действия, в которых вы можете использовать широкую экосистему PHP для решения своей задачи.

Функции

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

• Генерация OpenAPI
  Fusio автоматически генерирует спецификацию OpenAPI для определенных маршрутов.
• Генерация SDK
  Fusio может автоматически генерировать клиентский SDK для вашего API на основе заданной схемы.
• Поддержка вебхука
  Fusio содержит систему веб-перехватчиков, которая помогает создавать публикацию/подписку для вашего API.
• Ограничение скорости
  Fusio предоставляет возможность оценивать запросы на ограничение в зависимости от пользователя или приложения.
• Авторизация
  Fusio использует OAuth2 для авторизации API
• Монетизация
  Fusio предоставляет простую платежную систему для взимания платы за определенные маршруты.
• Валидация
  Fusio использует TypeSchema для автоматической проверки данных входящего запроса.
• Аналитика
  Fusio отслеживает все действия API и отображает их на информационной панели.
• Управление пользователями
  Fusio предоставляет приложение для разработчиков, в котором новые пользователи могут войти в систему или зарегистрировать новую учетную запись через GitHub, Google, Facebook или посредством обычной регистрации по электронной почте.

Приложения

Fusio предоставляет множество приложений, помогающих работать с API. В основном приложения представляют собой простые JS-приложения, которые работают с внутренним API Fusio. Вы можете увидеть список всех доступных приложений на нашей торговой площадке. Вы можете установить такое приложение либо с помощью команды CLI, например php bin/fusio marketplace:install fusio , либо через серверное приложение.

Все приложения устанавливаются в папку apps/ . Вам необходимо сообщить Fusio общедоступный URL-адрес папки приложений в файле .env , определив переменную APP_APPS_URL . В зависимости от ваших настроек это может быть либо собственный поддомен, например https://apps.acme.com , либо просто подпапка https://acme.com/apps .

Бэкэнд

Серверное приложение — это основное приложение для настройки и управления вашим API. Установщик автоматически установит это приложение. Приложение находится по адресу /apps/fusio/ .

VSCode

Fusio предоставляет расширение VSCode, которое можно использовать для упрощения разработки действий. Это означает, что вы можете разрабатывать каждое действие непосредственно внутри редактора VSCode.

SDK

Для создания и интеграции приложений с Fusio мы предоставляем несколько SDK, которые вы можете использовать для работы с экземпляром Fusio или просто вручную обратиться к REST API.

Язык	GitHub	Упаковка	Пример
С#	GitHub	NuGet	Пример
Идти	GitHub		Пример
Ява	GitHub	Мавен	Пример
Javascript	GitHub	НПМ
PHP	GitHub	Упаковщик	Пример
Питон	GitHub	ПиПИ	Пример

Рамки

Рамки	GitHub	Упаковка	Пример
Угловой	GitHub	НПМ	Пример

ОТДЫХ API

Домен	Документация	Спецификация
Бэкэнд	Редок	OpenAPI
Потребитель	Редок	OpenAPI
Система	Редок	OpenAPI

Экосистема

Fusio — это проект с открытым исходным кодом, который вы можете свободно использовать в частных и коммерческих проектах в соответствии с условиями лицензии Apache 2.0. Помимо нашего основного продукта, мы предлагаем дополнительные услуги по расширению функциональности Fusio.

• SDKgen
  SDKgen — это мощный генератор кода для автоматического создания клиентских SDK для вашего REST API.
• APIgen
  Создавайте полностью работающие и настраиваемые API на основе вашей модели данных.
• APIмон
  APImon предоставляет интуитивно понятный сервис для мониторинга и анализа конечных точек API.
• ТипСхема
  Формат JSON для описания моделей данных в независимом от языка формате.
• ТипAPI
  Альтернатива OpenAPI для описания REST API для генерации типовобезопасного кода.
• ТипХаб
  Платформа для совместной работы для проектирования и создания моделей API и клиентских SDK.
• PSX
  Инновационный PHP-фреймворк, предназначенный для создания полностью типизированных REST API.

Установка

Fusio можно установить либо через композитор, либо вручную загрузив файл.

Композитор

 composer create-project fusio/fusio

Скачать

https://github.com/apioo/fusio/releases

Конфигурация

Вы можете либо вручную установить Fusio, выполнив действия, описанные ниже, либо использовать установщик на основе браузера по адресу public/install.php . Обратите внимание, что из соображений безопасности настоятельно рекомендуется удалить сценарий установщика после установки.

• Настройте файл конфигурации
  Откройте файл .env в каталоге Fusio и измените APP_URL на домен, указывающий на общую папку. Также вставьте учетные данные базы данных в ключи APP_CONNECTION . Необязательно настройте APP_APPS_URL на общедоступный URL-адрес папки приложений (если вы хотите использовать приложения).
• Выполните команду установки
  Сценарий установки вставляет схему базы данных Fusio в предоставленную базу данных. Его можно выполнить с помощью следующей команды php bin/fusio migrate .
• Создать пользователя-администратора
  После завершения установки вам необходимо создать новую учетную запись администратора. Для этого вы можете использовать следующую команду php bin/fusio adduser . В качестве типа учетной записи выберите «Администратор».
• Установить серверное приложение
  Чтобы управлять своим API через панель администратора, вам необходимо установить серверное приложение. Приложение можно установить с помощью следующей команды php bin/fusio marketplace:install fusio

Вы можете проверить установку, посетив APP_URL в браузере. Вы должны увидеть ответ API о том, что установка прошла успешно.

Если вы хотите установить Fusio в конкретной базе данных, вам необходимо настроить параметр APP_CONNECTION . Вы можете использовать следующие строки подключения:

• MySQL: pdo-mysql://root:test1234@localhost/fusio
• PostgreSQL: pdo-pgsql://postgres:postgres@localhost/fusio
• SQLite: pdo-sqlite:///fusio.sqlite

В общем, Fusio можно установить на любую базу данных, которая поддерживается нашим уровнем абстракции базы данных, но наши внутренние тестовые примеры охватывают только MySQL, PostgreSQL и SQLite, поэтому нет никакой гарантии, что все работает.

Докер

Фузио можно настроить через докер. Преимущество этого подхода состоит в том, что вы автоматически получаете полностью работающую систему Fusio без настройки. Это особенно удобно для тестирования и оценки. Чтобы настроить контейнер, вам необходимо извлечь репозиторий и выполнить следующую команду:

 docker-compose up -d

При этом система Fusio создается с предопределенной внутренней учетной записью. Учетные данные берутся из переменных env FUSIO_BACKEND_USER , FUSIO_BACKEND_EMAIL и FUSIO_BACKEND_PW в файле docker-compose.yml . Если вы планируете запустить контейнер в Интернете, вам необходимо изменить эти учетные данные.

Домены

По умолчанию весь проект Fusio может размещаться на одном домене. В этой настройке ваш API обслуживается в корневом каталоге, а портал разработчика и серверные приложения обслуживаются непосредственно из папки /apps. Эта установка проста в использовании, поскольку не требует настройки. Если вы хотите запустить Fusio в производственной среде, мы рекомендуем создать следующую структуру поддоменов:

• api.acme.com
  Содержит только Fusio, где обслуживается ваш API. В этом случае вы можете удалить папку apps/ из общедоступной/папки.
• Developer.acme.com
  Содержит приложение портала разработчиков, где внешние разработчики могут зарегистрироваться.
• fusio.acme.com
  Дополнительное серверное приложение, с помощью которого вы можете управлять своим экземпляром Fusio. Вы также можете разместить это на совершенно отдельном внутреннем домене, серверному приложению нужен только доступ к API Fusio.

Конечно, это всего лишь предложение, и вы можете выбирать доменные имена по своему усмотрению.

Документация

Посетите наш официальный сайт документации, где мы собрали все ресурсы документации: https://docs.fusio-project.org/.

Поддерживать

Повышение

Если вы блоггер или журнал, мы будем рады, если вы захотите рассказать о Fusio. Пожалуйста, загляните в раздел «Медиа» на нашей странице «О программе», чтобы загрузить официальный набор значков. Если у вас есть какие-либо вопросы, напишите нам напрямую, чтобы мы могли помочь вам создать отличный контент.

Консалтинг

Если вы представляете компанию или фрилансера и хотите получить подробную информацию о том, как использовать Fusio, вы можете связаться с нами для консультации. На семинаре мы пытаемся найти лучший способ использования/интеграции Fusio, а также пытаемся объяснить функциональность и ответить на ваши вопросы.

Пожертвования

Если этот проект помогает вам получать доход или в целом вы хотите поддержать проект, ознакомьтесь с вариантами пожертвований в нашем репозитории.

Партнер

В следующем списке показаны все партнеры проекта Fusio. Мы хотели бы поблагодарить каждого партнера, который поддерживает нас в нашем стремлении вывести разработку API на новый уровень. Если вы заинтересованы в том, чтобы попасть в список здесь, не стесняйтесь спонсировать наш проект.