gothing / draft-front Goto Github PK

Хочется иметь возможность добавить разметку к описанию, а не просто plain-текст

Кейс:
Иногда возникает необходимость откатиться до какой либо предыдущей версии, при этом официальный развернутый фронт может быть обратно несовместим со схемой.

Возможное решение:
Было бы удобно иметь возможность развернуть инстанс фронта локально (например, в докер-контейнере)

После обновления фронта текст смещается вверх, что немного ухудшает восприятие информации.

Пример:
https://github.com/denis96z/draft-front/blob/screenshot/screenshot/screenshot_02.png

В структуре ответа поле указано как omitempty, внутри scheme.Case задается пример ответа, поле не инициализируется (пустая строка), но оно не пропадает в выводе godraft:doc. При этом другое поле находящееся в списке структур, с тем же тегом omitempty успешно скрывается

Получил:
https://github.com/denis96z/draft-front/blob/screenshot/screenshot/screenshot_03.png

Ожидал:
{"status":200} //body отсутствует

Кейс:
Документация доступна только из внутренней сети, при этом у сотрудника нет доступа к этой сети, однако ему необходимо иметь возможность ознакомиться с документацией

Было бы очень удобно иметь возможность экспортировать часть документации (например, текущую страницу) или всю документацию в отдельный файл (например, PDF)

{
    "status": 200,
    "body": {
        "accounts": [{"login":"[email protected]","name":"Елена Головач","first_name":"Елена","last_name":"Головач","image":"","type":"e"}]
}

хотелось бы, чтобы была возможность вложенные структуры (в том числе в массивах структур) выводить как pretty-print (например, через аннотации к полям ответа)

В body содержится пустой json.

В интерфейсе.
Получил:
https://github.com/denis96z/draft-front/blob/screenshot/screenshot/screenshot_04.png

Ожидал:
{"status":200} //без body аналогично #9

Добавился в gothing/draft#15 (с) @denis96z

Иногда изменения сделанные в схеме несовместимы с текущей версией фронта и наоборот. Было бы очень удобно визуально видеть текущую версию в интерфейсе доки, при этом чтобы номер версии брался из тега или хеша коммита.

Описание кейсов отображается в половину экрана, если список всех endpoint-ов слева не вмещается на один экран

Пример:
https://github.com/denis96z/draft-front/blob/screenshot/screenshot/screenshot_05.png

Кейс:
Некоторое API может принимать на вход только определенный Content-Type (application/x-www-form-urlencoded), хотелось бы иметь возможность отобразить это явно в документации

Если строка слишком длинная, она может обрезаться на узких экранах, при этом посмотреть содержимое полностью становится невозможно.

Пример:
https://github.com/denis96z/draft-front/blob/screenshot/screenshot/screenshot_01.png

Продолжение gothing/draft#15 и gothing/draft#16 (c) @denis96z