LINUX.ORG.RU

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


0

2

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

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

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

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

★★★★☆

Ответ на: комментарий от shrub

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

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

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

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

stevejobs ★★★★☆
() автор топика
Ответ на: комментарий от pylin

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

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

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

stevejobs ★★★★☆
() автор топика
Ответ на: комментарий от stevejobs

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

pylin ★★★★★
()

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

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

zinfandel ★★
()
Последнее исправление: zinfandel (всего исправлений: 1)
Вы не можете добавлять комментарии в эту тему. Тема перемещена в архив.