Как узнать CouchDB API без документации?

Question

Поскольку в CouchDB очень мало документации по API (по крайней мере, я не могу ее найти), я бы сам хотел проверить некоторые объекты JavaScript. Каков наилучший способ сделать это?

Например, функции show получают объект запроса req в качестве аргумента. Как узнать, какими свойствами (куки, запрошенный URL, ...) этот объект запроса точно обладает?

Answer 1

Для вашего конкретного вопроса - как написать _show функции - см. Соответствующую документацию в CouchDB Wiki : Форматирование с помощью Show и List .Затем этот документ дает перекрестные ссылки на документацию Внешние процессы для получения подробной информации об объекте запроса.В общем, вики - это клад информации - большая часть документации по API там.Это может занять некоторое время.

Вы также можете напрямую поэкспериментировать с JavaScript, как указал Натан.Вы можете написать функцию show, которая просто строковые параметры (с JSON.stringify()) и отображает их, чтобы вы могли видеть, что они на самом деле.

Answer 2

Вы можете написать код для проверки свойств объекта, см. Перебор каждого свойства объекта в javascript с использованием Prototype?

Answer 3

Меня тоже не устраивает документация по couchdb.

В Руководстве CouchDB есть некоторая информация об объекте req, который передается в функцию списка: http://guide.couchdb.org/editions/1/en/transforming.html

Iдумаю, в функциях show это будет выглядеть примерно так же.

Но вы также должны иметь возможность использовать toJSON (req) для получения его содержимого.

Answer 4

Посмотрите Документы CouchOne и открытую Книгу CouchDB .

Answer 5

Чтобы ответить на ваш первоначальный вопрос, я часто пишу функцию быстрого показа / списка, похожую на этот пример, чтобы быстро пробежаться в памяти по поводу параметров запроса (или других):

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