srijanone / ezdevportal

EzDevPortal API 交换

维护者

详情

github.com/srijanone/ezdevportal

主页

源代码

问题: 157

安装: 1

依赖项: 0

建议者: 0

安全: 0

星级: 2

关注者: 0

分支: 2

开放问题

2.0.2 2023-10-10 11:04 UTC

类型:drupal-profile

  • README
  • 关于 EzDevPortal
  • 特性
  • 架构亮点
  • Drupal 9 安装

README

致谢

关于 EzDevPortal

EzDevPortal 是一个用于设置完全可定制的开发者门户的 Drupal 安装配置文件。无论你是想要发布 API 以供应用开发者使用的 SaaS 公司,还是拥有庞大 OpenBanking API 程序的金融机构,都可以使用 EzDevPortal 来构建专属的开发者体验。

  • 关键特性

    产品与 API 分类

  • 将具有相似属性的 API 和产品组织成类别和目录,以便快速导航和发现。

    自助功能

  • 包含自定义工作流程,简化了内容与访问控制等管理流程,并简化了上下游用户旅程的入职流程。

    分析

  • 集成 Google Analytics 以跟踪和查看会话信息、顶级页面、关键词等报告。此外,还可以跟踪 API 使用情况等应用程序分析。

    自定义 APIM 连接器

  • 通过预配置的连接器,将开发者门户与您的 APIM 集成,以便管理开发者的访问请求等。

    API 文档

  • 支持从多种语言生成 API 文档,包括 OAS (swagger)、Rapidoc 和代码片段。

    增强的站内搜索

  • 高级搜索功能,方便浏览和搜索 API 目录。

    SDK 下载支持

  • 自动生成客户端 SDK,以创建可以消费订阅的 API 的应用程序。

    内容管理

通过创建和管理页面、博客、媒体、用例、论坛和常见问题解答来构建 API 生态系统。

  • 详细特性列表
    • 使用各种特性对 API 进行产品化
    • 指南(页面)
    • 用例
    • 常见问题解答
    • 教程
    • 媒体
  • 博客
  • 产品分类
  • 支持多种视图的 Open API 规范
    • Rapidoc
    • Swagger
    • Redoc
  • 支持异步 API
  • 支持 GraphQL
  • 支持 SDK 下载
  • 支持使用电子邮件/Github/Gmail 进行用户注册/登录
  • 用户仪表板
  • 论坛(社区支持)
  • 问题(组织支持)
  • 通知(电子邮件和警报)
  • 搜索
  • 内容管理站点管理员功能
  • 创建自定义页面进行品牌/营销
  • 可选快速入门内容
  • 支持各种 API 网关的可插拔连接器,如 Apigee、Kong、AWS API Gateway、Azure API Gateway

特性

  • 开源:基于 Drupal CMS 构建,并支持完整的产品管理 API 生命周期。
  • 通过 Drupal 布局构建器、丰富的媒体库、自定义主题、文本编辑器等,提供完全可定制的 UI 支持。
  • 基于插件的 API 连接器架构,可以轻松扩展以创建新的连接器。
  • 支持在任何基础设施上托管:PaaS、公共云
  • 支持使用 Portal Management Rest API 的基于 HTML 或 JavaScript 的前端

架构亮点

先决条件

- PHP >= 8.0
- MariaDB 10.3.7+
- MySQL 5.7.8+
- Composer = 2.*

EzDevPortal 使用 composer 来管理其依赖项。因此,在使用 EzDevPortal 之前,请确保您的机器上已安装 composer。

从源代码安装

git clone git@github.com:srijanone/ezdevportal-project.git
cd ezdevportal-project
composer install

通过 composer 安装

  • 为您的项目选择一个名称,例如“MY_PROJECT”
  • 使用以下命令创建项目
  • 该命令将下载 Drupal 核心以及必要的模块、EzDevPortal 配置文件和项目所需的所有其他依赖项
composer create-project srijanone/ezdevportal-project
MY_PROJECT --no-interaction

如果在内存问题上遇到任何问题,请运行以下命令:

php -d memory_limit=-1 /path/to/composer.phar create-project
srijanone/ezdevportal-project MY_PROJECT --no-interaction

您可以通过 drush 或使用 GUI 方法安装网站。

Drush 方法

通过终端导航到项目根目录,并执行以下命令

./vendor/bin/drush si ezdevportal
--db-url='mysql://{mysql_user}:{mysql_password}@{mysql_host}/{db_name}'
--site-name='EzDevPortal' --account-name='Srijan'
--account-pass='Admin@123'  --account-mail='admin@example.com' -y

图形界面方法

使用 docker (ddev, lando 等) 或 LAMP 栈设置本地环境。

运行正常的 Drupal 图形界面安装过程。您可以选择在安装过程中安装演示模块,或者您可以稍后在扩展页面或使用 drush 安装它。

安装演示模块后,清除 Drupal 缓存。

Drupal 9 安装