Ищется красивый визуализатор API

0

2

У нас есть софтина.
У софтины есть REST API, работающее через интернет.

Хочется сделать сайт с документацией по этому апи.
Урлы, параметры с описанием, разбор что означает json-ответ.

Апи - знание чисто человеческое, его не нужно генерить из кода.

Есть ли что-то готовое для этого?

Ссылка

←	expect скрипт

Отладка нескольких процессов

→

http://sphinx-doc.org/

shrub ★★★★★
(02.04.14 21:49:02 MSK)

Ответ на: комментарий от shrub 02.04.14 21:49:02 MSK

гляди, в нашем апи около 20 функций.

поэтому тулзы для организации сложной документации - не нужны.

нужен именно красивый, чистый, понятный дизайн.

особенно интересно, как аннотировать результирующий json, с точки зрения хорошего дизайна (и, возможно, иметь такую фичу в том самом движке-визуализаторе)

~~stevejobs~~ ★★★★☆
(02.04.14 21:57:50 MSK) автор топика

Ответ на: комментарий от stevejobs 02.04.14 21:57:50 MSK

Гляди, идет время и ваши 20 начнут меняться, добавляться, убавляться и т.д.

~~pylin~~ ★★★★★
(02.04.14 22:00:13 MSK)

Ответ на: комментарий от pylin 02.04.14 22:00:13 MSK

Когда их будет много - сделаем что-то другое. А пока нужен хороший дизайн.

Вот пример как люди аналогичную задачу решают с помощью плохого дизайна: http://docs.basho.com/riak/latest/dev/using/search/#Query-Syntax

Всё намешано в кашу, ничего не понятно, в экран не вмещается.

~~stevejobs~~ ★★★★☆
(02.04.14 22:03:12 MSK) автор топика

Ответ на: комментарий от stevejobs 02.04.14 22:03:12 MSK

Ну так Sphinx это вполне годно, в конце концов никто ж не требует, чтобы он стоял на вашем боевом сервере

~~pylin~~ ★★★★★
(02.04.14 22:05:07 MSK)

Ссылка

plantuml, graphviz.

ziemin ★★
(02.04.14 22:06:42 MSK)

Ссылка

Вроде есть такой сайт — аггрегатор документации по апи для различных сервисов, достататочно красивый + есть всякий функционал типо выполнения тестовых запросов.

Ну или просто спереть CSS у twitter/reddit/...

zinfandel ★★
(02.04.14 22:24:20 MSK)
Последнее исправление: zinfandel 02.04.14 22:24:42 MSK (всего исправлений: 1)