platformatory/opendevx-project

OpendevX的项目模板

1.0.1 2021-05-06 18:40 UTC

This package is auto-updated.

Last update: 2024-09-29 06:02:58 UTC


README

概述

OpenDevX是一个开源框架,用于构建API开发者交易所和集市。OpenDevX可能是一个针对现有企业(在API管理平台上有投资)、*作为服务公司及ISV构建面向开发者的数字生态系统的优秀入门套件。

功能

  • 与API生命周期管理系统集成:从支持的源发现API:企业API平台、API网关、服务网格或其他任何东西(自带API提供者)
  • 将API组织到业务或受众领域:每个领域都提供团队级功能,用于运行开发者计划和相关的开发者交易所,在该领域发布和消费API。
  • 可定制的开发者交易所:全面控制品牌、布局以及开发者旅程
  • 内置开发者体验:门户和自助服务体验,包括API接口文档、“试用”控制台、人工精选文档以及通过帮助台集成支持
  • 使用灵活的计费计划、内置使用连接器以及与基于订阅/使用情况的计费服务提供商集成来货币化API
  • 踏上成熟您的API项目之旅:建立社区、管理开发者关系(DevRel)以及围绕您的API项目/产品性能(如平均每个开发者的收入)的可行数据洞察

安装

  • 您可以通过git克隆此仓库或使用composer create-project platformatory/opendevx-project:$TAG /path/to/your-dir来安装此项目
  • 如果您使用lando,您应该能够使用lando start启动并运行包含在内的本地环境

OpenDevX企业版(2021年宪章客户计划)

  • OpenDevX企业版具有OpenDevX的完全“企业级”功能,包括但不限于OpenDevX中心(网关和计费连接器的托管解决方案)、SSO集成、99.5 SLA部署(SaaS)、开发者计划分析以及更多。
  • Platformatory为企业提供付费支持、托管服务、专业咨询服务、连接器开发、门户和定制部署(包括私有/混合云)。如果您感兴趣,请联系我们。

为开发做出贡献

  • 修改您的composer.json以添加dev分支:例如 - 分发的dev-beta。验证您是否能够访问web/profiles/contrib/opendevx的git远程
  • 建议您在本地覆盖composer.json VCS并将其设置为本地仓库路径:例如,这可能为
"repositories": [
  {
    "type": "path"
     "url": "/home/user/projects/opendevx-project/web/profiles/contrib/opendevx"
  }
]
  • 除非您知道如何正确锁定依赖项,否则不建议保留锁文件(除非在敏感环境中)
  • 如果您使用此项目设置了您的环境,您必须注意向正确的仓库发送拉取请求(即platformatory/opendevx);为了实用,我们包括一个名为config-sink.sh的辅助脚本。此脚本从您导出的配置中清除UUID和哈希,以便可以将其与分发合并。包依赖遵循相同的流程,必须针对分发版的composer.json进行PR。