如何在没有文档的情况下学习CouchDB API？

Question

由于CouchDB的API文档很少（至少我找不到它），我想自己检查一些JavaScript目标。这样做的最佳方式是什么？

例如，show functions将请求对象req作为参数。如何找出这个请求对象具有哪些属性（cookie，请求的URL，...）？

Answer 1

针对您的具体问题 - 如何编写_show个函数 - 请参阅CouchDB Wiki：Formatting with Show and List中的相关文档。然后，该文档交叉引用External Processes文档，以获取有关请求对象的详细信息。一般来说，维基是一个信息宝库 - 大多数API文档都在那里。它可以看一些。

如Nathan所示，您也可以直接使用JavaScript进行实验。您可以编写一个show函数，只是将参数字符串化（使用JSON.stringify()）并显示它们，以便您可以看到它们实际上是什么。

Answer 2

查看CouchOne Docs和开放CouchDB Book。

Answer 3

您可以编写代码来检查对象具有哪些属性，请参阅Iterating over every property of an object in javascript using Prototype?

Answer 4

我对couchdb文档也不满意。

在CouchDB指南中，有一些关于传递给列表函数的req对象的信息：http://guide.couchdb.org/editions/1/en/transforming.html

我想在show函数中看起来会非常相似。

但是你也应该能够使用toJSON（req）来获取它的内容。

Answer 5

为了回答你原来的问题，我经常发现自己正在编写一个类似于这个例子的快速显示/列表功能，以快速记录我对请求（或其他）选项的记忆：

function (doc, req) {
    provides("text", function () {
        return JSON.stringify(req, null, 4);
    });
}