gothing / draft-front Goto Github PK
View Code? Open in Web Editor NEWHome Page: https://gothing.github.io/draft-front/
Home Page: https://gothing.github.io/draft-front/
Описание кейсов отображается в половину экрана, если список всех endpoint-ов слева не вмещается на один экран
Пример:
https://github.com/denis96z/draft-front/blob/screenshot/screenshot/screenshot_05.png
Хочется иметь возможность добавить разметку к описанию, а не просто plain-текст
{
"status": 200,
"body": {
"accounts": [{"login":"[email protected]","name":"Елена Головач","first_name":"Елена","last_name":"Головач","image":"","type":"e"}]
}
хотелось бы, чтобы была возможность вложенные структуры (в том числе в массивах структур) выводить как pretty-print (например, через аннотации к полям ответа)
После обновления фронта текст смещается вверх, что немного ухудшает восприятие информации.
Пример:
https://github.com/denis96z/draft-front/blob/screenshot/screenshot/screenshot_02.png
Кейс:
Документация доступна только из внутренней сети, при этом у сотрудника нет доступа к этой сети, однако ему необходимо иметь возможность ознакомиться с документацией
Было бы очень удобно иметь возможность экспортировать часть документации (например, текущую страницу) или всю документацию в отдельный файл (например, PDF)
Если строка слишком длинная, она может обрезаться на узких экранах, при этом посмотреть содержимое полностью становится невозможно.
Пример:
https://github.com/denis96z/draft-front/blob/screenshot/screenshot/screenshot_01.png
Продолжение gothing/draft#15 и gothing/draft#16 (c) @denis96z
В структуре ответа поле указано как omitempty, внутри scheme.Case задается пример ответа, поле не инициализируется (пустая строка), но оно не пропадает в выводе godraft:doc. При этом другое поле находящееся в списке структур, с тем же тегом omitempty успешно скрывается
Получил:
https://github.com/denis96z/draft-front/blob/screenshot/screenshot/screenshot_03.png
Ожидал:
{"status":200} //body отсутствует
Добавился в gothing/draft#15 (с) @denis96z
В body содержится пустой json.
В интерфейсе.
Получил:
https://github.com/denis96z/draft-front/blob/screenshot/screenshot/screenshot_04.png
Ожидал:
{"status":200} //без body аналогично #9
Кейс:
Некоторое API может принимать на вход только определенный Content-Type (application/x-www-form-urlencoded), хотелось бы иметь возможность отобразить это явно в документации
Иногда изменения сделанные в схеме несовместимы с текущей версией фронта и наоборот. Было бы очень удобно визуально видеть текущую версию в интерфейсе доки, при этом чтобы номер версии брался из тега или хеша коммита.
Кейс:
Иногда возникает необходимость откатиться до какой либо предыдущей версии, при этом официальный развернутый фронт может быть обратно несовместим со схемой.
Возможное решение:
Было бы удобно иметь возможность развернуть инстанс фронта локально (например, в докер-контейнере)
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.