如何在解析服务器应用程序上生成文档

Posted 2023-03-16

【中文标题】如何在解析服务器应用程序上生成文档

【英文标题】：how to generate documentation on parse server application

【发布时间】：2017-12-31 04:25:38

【问题描述】：

我想知道我们是否可以在我们的解析服务器驱动的 express 应用程序中根据我们的模式/类生成文档。

我还有大约 15 个云功能需要有特定的帖子正文。有文档生成器会很棒

【问题讨论】：

到目前为止您尝试过什么？显示一些代码。

+ Ataur Ra​​hman Munna，我相信没有参考指出如何在解析文档中生成文档并在谷歌上搜索。我如何“尝试”无中生有的编码

那么你能用swagger-uiswagger.io吗？

【参考方案1】：

我不知道任何用于 Parse 类模式的 APIDOC 生成器。然而，一个好的起点可能是Schema APIs，它允许您获取应用程序中类模式的 JSON 描述。它们返回一种简单的格式，您可以将其转换并输入到您选择的文档工具中。

对于云代码函数，无法自动执行 IMO：函数的参数和结果没有在任何地方明确定义，函数只是获取并返回纯 javascript 对象——只要它能够处理请求参数和客户端可以处理响应，它可以工作。作为一种解决方法 - 再次 - 您可以将 Cloud Code 函数编写为普通函数，使用众多 JS 类型信息系统之一（甚至使用 TypeScript）对它们进行注释，从而启用 APIDOC 工具；这些普通函数通过一个简单的包装器暴露给 Parse，该包装器处理从 request 对象到函数输入参数以及从函数结果（或错误）到 response 对象的转换。