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

Question

我想知道我们是否可以在我们的解析服务器驱动的快速应用程序中基于我们的架构/类生成文档。

此外，我还有大约15个云功能，需要具有特定的帖子体。拥有文档生成器

非常棒

Answer 1

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

对于Cloud Code函数，没有办法自动执行IMO：函数的参数和结果没有在任何地方显式定义，函数只是获取并返回纯JavaScript对象 - 只要它可以处理请求参数，客户端可以处理响应，它的工作原理。作为一种解决方法 - 再次 - 您可以将您的Cloud Code函数编写为普通函数，使用众多JS类型信息系统之一（甚至使用TypeScript）对它们进行注释，从而支持使用API​​DOC工具;这些普通函数通过一个简单的包装器向Parse公开，该包装器处理从request对象到函数输入参数的转换，以及从函数的结果（或错误）到{{1对象。