srijanone/opendevportal

OpenDevPortal API 交换

安装: 216

依赖项: 1

建议者: 0

安全: 0

星星: 1

关注者: 10

分支: 2

开放问题: 12

语言:CSS

类型:drupal-profile

1.0.1 2021-01-21 12:38 UTC

README

OpenDevPortal是一个用于构建自定义开发者门户的产品框架。无论是希望发布API给应用开发者使用的SaaS公司,还是拥有庞大OpenBanking API计划的金融机构,都可以使用OpenDevPortal来打造定制的开发者体验。

OpenDevPortal的一些最独特功能

  • API计划与产品管理,具有访问控制
  • 完全可定制的开发者体验和计划品牌化
  • 基于连接器的架构(用于API网关和集成系统)
  • 开发者与生态系统指标

用例

  • 管理API产品 并以规模运行API计划。获得一个统一平台,处理产品目录、计划管理和治理,同时确保完全的计划自主性。

  • 提供一流的开发者体验,包括轻松的API发现、精心挑选的互动文档和资源、企业级和社区支持等。

  • 建立开发者关系 与开发者营销。根据统一的360度开发者个人资料提供个性化体验和基于上下文的推荐,并提高社区参与度和开发者留存率。

  • 货币化、衡量和监控您的API计划。设置和跟踪API产品和计划OKRs/KPIs,包括收入、开发者参与度和使用目标。还可以定义计费计划和计费模式,并与现有计费系统集成。

架构关键亮点

  • 一个多租户平台统治一切 = 在一个伞下管理多个网关下的多个API计划和产品
  • 基于插件的API连接器架构,可以轻松扩展以创建新的连接器:网关、计费、工作流程扩展等
  • 开源:在Drupal CMS上构建,并支持完整的API生命周期管理
  • 通过Drupal布局构建器、丰富的媒体库、自定义主题、文本编辑器等提供完全可定制的UI支持
  • 任何基础设施:SaaS、PaaS、公共云
  • 支持使用基于HTML或JavaScript的前端,利用门户管理REST API

安装

先决条件

- PHP >= 7.3
- MySQL >= 5.7
- Composer = 1.*

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

从源安装

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

通过Composer Create-Project安装

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

如果遇到内存问题,请运行以下命令-

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

使用drush安装-

time php -d memory_limit=-1 ./vendor/bin/drush si opendevportal  --db-url='mysql://drupal_user:drupal_password@localhost/drupal_db' --site-name='OpenDevPortal' --account-name='Srijan' --account-pass='Admin@123'  --account-mail='admin@example.com' -y

功能

  • 多租户
    • 多个开发者计划
    • 计划级别的定制
    • 每个计划支持自定义域名
  • 开发者计划的多种样式
    • 公共的
    • 私有的
    • 受保护的
  • 使用各种功能将API产品化
    • 指南(页面)
    • 用例
    • 常见问题解答
    • 教程
    • 下载
    • 媒体
    • 博客
    • 事件
    • 解决方案
    • 问题
  • 产品与API分类
  • NPS
  • 社交分享
  • 标签功能
  • 支持多种视图的 Open API 规范
    • Rapidoc
    • Swagger
    • Redoc
  • 支持异步 API
  • 支持 GraphQL
  • 支持 SDK 下载
  • 支持使用电子邮件/Github id/Gmail id 注册用户
  • 用户仪表板
  • 支持 SAML/Github/Gmail 登录功能
  • 支持 Google Captcha 进行身份验证
  • 论坛(社区支持)
  • 问题(组织支持)
  • 自定义工作流程
  • 通知(电子邮件与警报)
  • 搜索
  • 支持定制页面用于品牌/营销
  • 支持自定义连接器

申请演示

贡献

致谢