DreamFactory入门指南

DreamFactory入门指南

 

欢迎来到DreamFactory平台！无论您是开源用户还是利用DreamFactory高级功能的付费客户，我们都会编写本指南，以帮助您以最有效的方式开始将平台整合到您的组织中。

警告 本指南正在大力发展，并且正在进行中。经常回来查看，因为我们会定期发布更新！

 

＃关于本指南

本指南由许多章节组成，涵盖以下主题：

 

＃第1章REST和DreamFactory简介

那你为什么要首先使用DreamFactory平台呢？这可能是因为即使是世界级的开发人员和管理员也面临着日益增加的复杂性，这在很大程度上归功于必须与移动和Web应用程序，ERP解决方案以及无数其他服务集成的大量内部和第三方数据源。在本章中，您将了解DreamFactory如何通过向您的企业引入孤岛破解功能来为这种混乱带来秩序，提供一个平台，您不仅可以自动生成用于连接这些数据源的API，还可以保护和监控他们。

 

＃第2章安装和配置DreamFactory

DreamFactory平台的大部分都是开源的，代码可以通过GitHub获得。但这并不意味着您必须成为一个命令行向导才能开始在Flash中生成API。在本章中，您将学习如何安装和配置DreamFactory，无论您的操作系统或经验级别如何。我们还将讨论配置DreamFactory以满足您的特定需求，并突出显示关键配置更改，这将使您的生活更轻松。

 

＃第3章。生成数据库支持的API

安装DreamFactory实例后，您自然希望将平台用于测试驱动器。大多数用户希望从生成数据库API开始，因为这样做的优点是如此明显。通过仅提供一组身份验证凭据，DreamFactory将为任何流行数据库生成API，包括MySQL，SQL Server，Oracle，PostgreSQL，MongoDB等。生成后，您可以立即发出REST API调用以执行记录创建，检索，修改和删除任务。您还可以使用REST API执行高级查询，包括过滤器，分组，连接，限制等。

 

＃第4章认证和监控用户

从生成API的那一刻起，请确保它至少受到复杂API密钥的保护。但是，这仅仅是关于保护API的选项的开始。您可以使用DreamFactory的用户身份验证和授权功能，通过各种身份验证解决方案（包括基本身份验证，LDAP，Active Directory和SSO）提供特定于用户的登录。在本章中，您将学习有关这些解决方案的所有内容，另外还将学习如何使用DreamFactory的速率限制和日志记录功能来密切监视请求量和行为。

 

＃第5章。生成SOAP-to-REST API

DreamFactory提供了一个非常强大的解决方案，用于创建API并使用各种流行的脚本语言（包括PHP，Python（版本2和3），Node.js和JavaScript）向现有API添加业务逻辑。在本章中，我们将向您介绍几个示例，这些示例有望激发您对利用这一强大功能的多种方式的想象力。

 

＃第6章将业务逻辑集成到DreamFactory API中

仅仅自动生成REST API的能力已经可以立即提高生产力，但最终您将需要调整一个或多个API端点的默认行为以满足更复杂的项目要求。这通常涉及使用DreamFactory的脚本功能，该功能允许您编写用于验证输入参数的自定义代码，调用其他API等等。在本章中，我们将介绍几个真实的示例，这些示例强调了使用四个受支持的脚本引擎（NodeJS，PHP，Python和V8JS）之一扩展API端点是多么容易。

 

＃第7章限制和记录API请求

在本章中，您将学习如何使用DreamFactory的API限制和日志记录功能来分配和监控对受限API的访问。

 

＃第8章保护DreamFactory环境

虽然DreamFactory已经安全且相对免维护，但您可以进行相当多的修改来增强您的实例。在本章中，我们将提供您可以进行的许多更改的广泛概述，以便维护和保护您的环境。

 

＃第9章性能注意事项

DreamFactory已经非常高效，但从逻辑上讲，你会想要做一切切实可行的事情来确保你的实例能够真正飞行。在本章中，我们将提供一些基准，以及有关如何正确调整实例环境的指导。

 

＃10章上的覆盆子裨安装DreamFactory

DreamFactory是一个非常吸引人的项目，它的架构适用于无限的水平和垂直扩展，但可以在像Raspberry Pi这样的小型设备上运行。在本章中，我们将讨论与在Raspberry Pi上安装DreamFactory的先决条件相关的一些与配置相关的问题。

 

＃第11章JavaScript示例

在本章中，我们将提供一些基于JavaScript的示例，演示Web应用程序如何与暴露于DreamFactory的API进行交互。

 

＃第12章创建文件系统API

DreamFactory支持基于文件系统的API生成，这意味着您可以为AWS S3，SFTP，本地文件存储等创建REST API。在本章中，我们将向您展示如何。

 

＃第13章使用DreamFactory集成Salesforce数据

在本章中，您将学习如何配置连接器，然后使用DreamFactory生成的REST API与Salesforce数据库进行交互。

 

＃第14章使用DreamFactory的远程HTTP和SOAP连接器

虽然DreamFactory Platform以生成REST API的能力而闻名，但许多人也利用该平台的远程服务连接器。在本章中，您将学习如何通过DreamFactory代理第三方HTTP API，并另外将现有SOAP服务挂载到DreamFactory并使用自动生成的REST接口与其进行交互。

 

＃第15章使用系统API

所有DreamFactory版本都包含一个基于Web的管理控制台，用于管理平台的所有方面。虽然此控制台为执行诸如管理API，管理员和业务逻辑等任务提供了用户友好的解决方案，但许多公司希望通过脚本来自动执行管理任务。在本章中，您将学习如何与系统API交互以轻松管理多个DreamFactory环境，并将DreamFactory功能集成到第三方应用程序（如API货币化SaaS）中。

 

#A附录A.配置参数参考

DreamFactory具有能够通过配置参数进行调整的功能。这些参数可以作为服务器环境变量进行管理，也可以.env在平台根目录中的文件中进行管理。本附录定义了所有可用参数。

 

＃附录B.安全常见问题

负责管理敏感数据的客户通常会询问有关公司和平台安全策略的严格问题。

 

＃附录C.利用API网关实现GDPR准备

本文概述了如何利用API平台改进现有的“GDPR准备”基础设施，实质上是实现数字化转型的现代架构的副产品。

 

＃附录D.检查DreamFactorys架构

本文回答了有关Dreamfactorys系统的常见问题以及各种API调用在系统中的解剖。

 

＃附录E缩放DreamFactory

本文旨在为企业客户提供有关如何扩展DreamFactory实例的信息。以下部分讨论了水平，垂直和云缩放功能。

 

＃更多学习方法

希望您会发现本指南不可或缺，但它只是您可以使用的几种学习资源之一。查看以下链接，了解有关其他可用内容的更多信息！

 

＃在DreamFactory维基

DreamFactory wiki是我们的权威参考指南，提供了该平台主要功能的简洁而全面的摘要。在这里，您可以找到安装说明，脚本示例以及大量其他信息。

 

＃视频

DreamFactory Youtube频道提供了数十个视频。还可以看看DreamFactory Academy

 

＃在DreamFactory论坛

志愿者和DreamFactory员工都定期巡视我们的社区论坛。如果首选Stack Overflow，请务必使用dreamfactory标记标记问题！

 

＃API成本计算器

想知道构建API需要多少成本？查看我们的API计算器，它根据众多研究和我们与全球数千名客户的互动来计算API开发成本。

 

＃联系我们

您对本指南或DreamFactory平台有任何意见或疑问吗？我们很乐意听取您的意见！通过电子邮件向我们的支持团队发送反馈。