修改API Docs选项卡中生成的预定义API文档可能有各种各样的原因。我们将讨论修改文档和导出文档,以拥有无需任何编码的开发人员门户。
导出API文档
当你在任何服务的API文档中看到下载服务文档
在这一页的顶部。这将下载JSON格式的文档以供在其他地方使用。在本例中,我们下载服务定义并将其导入SwaggerHub.这个工具使我们能够利用DreamFactory文档,修改端点,并将其作为开发人员门户公开。
然后我们可以使用一个工具,比如JSON2YAML将我们的服务定义从JSON转换为YAML。现在我们可以把它粘贴到SwaggerHub.您可能会注意到它运行得不好,这是因为我们需要将它指向我们的DreamFactory实例。
下服务器
部分,你会想添加你的DreamFactory实例的细节如下:
servers:—url: '{server}/api/v2/{service_name}' description: 'DreamFactory Demo'变量:server: default: https://YOUR_INSTANCE.com
现在您就有了一个功能齐全的API开发人员门户!
修改现有API文档
要修改现有的API文档,我们仍然需要下载服务文档。有了文档之后,我们不能对其进行修改,也不能更改现有的服务文档,而是使用该文档创建一个新的服务。
定制文档
定制你的API文档是相当简单的。首先,您可以简单地查看一下现有的结构,并将其用作自定义文档的样板。在本例中,我们将删除/ _schema
,/ _function
,/ _proc
完全的端点。
首先,我们修改下载的服务定义。我们可以简单地向下导航到“路径”,并开始从文档中删除端点。当我们删除这些端点时,您可能还会注意到,摘要和描述也可以根据您的喜好进行修改。
创建一个新的API
方法将这个自定义文档导入到DreamFactoryHTTP连接器.我们首先为定制的API指定基本URL,并为服务提供API密钥。
然后我们转到服务定义
选项卡,我们只需复制并粘贴文档。
一旦完成,我们可以保存它并导航到API文档
查看我们的自定义文档。