Коллеги, всем привет Подскажите, кто как документирует своё API? Понимаю, что

Question

Коллеги, всем привет Подскажите, кто как документирует своё API? Понимаю, что

схема сама по себе документация, но хочется оформить в виде сайта с примерами запросов и процессами, в идеале с возможностью потыкать запросы прям там. Подозреваю, что придётся делать самому что-то вроде плагина к анторе для такого, но может быть есть готовое решение?

#graphql #programming #russian

0

27.11.2020

5 ответов

13 просмотров

Анатолий Нечай-Гумен Автор вопроса

Eugene
А чем playground не устраивает

Задача то именно в документации с примерами запросов и процессов, для публичного API. Невежливо как-то кидаться в клиентов и партнёров Playground-ом - мол, разбирайтесь сами)

0

27.11.2020

Roman Lykov

Можно сделать генерацию тайпингов с хуками, там будут примеры под каждый запрос

0

27.11.2020

Alexey Rodionov

Если в схеме ко всем типам, полям, аргументам и т.д. написаны описания (GraphQL поддерживает Markdown), то существуют генераторы документации из GraphQL-схемы. Например: https://github.com/OneGraph/graphql-codex

0

27.11.2020

Анатолий Нечай-Гумен Автор вопроса

Alexey Rodionov
Если в схеме ко всем типам, полям, аргументам и т....

Благодарю за подробный ответ, некоторые из тулз не видел еще Меня скорее интересовал вопрос встраивания Playground в обычную документацию (asciidoc, markdown) Я уже нашел похожее, но перспектива использовать rst не вдохновила: https://github.com/hasura/sphinx-graphiql Пока остановились на том, что будем видимо делать свой плагин к asciidoc, для встраивания примеров запросов

0

27.11.2020

Eugene · Accepted Answer

Eugene

А чем playground не устраивает

0

27.11.2020

169 похожих чатов

Коллеги, всем привет Подскажите, кто как документирует своё API? Понимаю, что

5 ответов

Похожие вопросы