Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Добавил стадию документирования Swagger #63

Open
wants to merge 22 commits into
base: develop
Choose a base branch
from

Conversation

kuzja086
Copy link
Contributor

@kuzja086 kuzja086 commented Dec 1, 2021

Closes #44 Добавил новую стадию документирования.

@kuzja086
Copy link
Contributor Author

kuzja086 commented Dec 1, 2021

Класс Vrunner для вызова другой команды Oscript по сути ведь надо делать тоже самое, только вместо vrunner подставить swagger в моем случае. Может сделать какой-то универсальный класс??

vars/pipeline1C.groovy Outdated Show resolved Hide resolved
@nixel2007
Copy link
Member

Класс Vrunner для вызова другой команды Oscript по сути ведь надо делать тоже самое, только вместо vrunner подставить swagger в моем случае. Может сделать какой-то универсальный класс??

можно получение пути к бинарю (с учетом проверки на isUnix и наличие oscript_modules) можно вынести в отделный класс со статик-методом, куда бы передавать имя бинаря.

@kuzja086
Copy link
Contributor Author

kuzja086 commented Dec 3, 2021

Класс Vrunner для вызова другой команды Oscript по сути ведь надо делать тоже самое, только вместо vrunner подставить swagger в моем случае. Может сделать какой-то универсальный класс??

можно получение пути к бинарю (с учетом проверки на isUnix и наличие oscript_modules) можно вынести в отделный класс со статик-методом, куда бы передавать имя бинаря.

Вынес отдельно, но для Раннера не стал исправлять, думаю это надо отдельным реквестом, чтобы проверить все вызовы.

@kuzja086 kuzja086 marked this pull request as ready for review December 3, 2021 12:04
@nixel2007
Copy link
Member

тэкс, а может еще плагин html-publish завернуть тогда? чтобы сразу в дженкинсе можно было смотреть результат?


steps.cmd(swaggerPath + " generate --src-path $config.srcDir --out $OUT")

def dir = new File(OUT)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Нельзя использовать File. Нужно взять шаг, который бы вернул список файлов.

steps.cmd(swaggerPath + " generate --src-path $config.srcDir --out $OUT")

def dir = new File(OUT)
dir.eachFile(FileType.FILES){
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Разве там несколько сайтов? Я не пробовал запускать ещё, но думал, что там каталог с набором файлов и единственным index.html.

Если он там один, то достаточно один раз вызвать publishHTML на каталог

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

посмотрел, да, там их несколько.

раньше у publishHTML была особенность - его нельзя было вызывать несколько раз. нужно было подготовить массив из описаний публикаций и вызывать publishHTML один раз, передавая туда массив.

Logger.println(reportdir)
Logger.println(it.path)
steps.cmd("bootprint openapi $it.path $reportdir")
publishHTML (target : [allowMissing: false,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Нужно обернуть вызов в steps. В контексте этого класса нет метода publishHTML

dir.eachFile(FileType.FILES){
Logger.println(it.name)
Logger.println(it.path)
steps.cmd("bootprint openapi $it.path $OUT_HTML")
Copy link
Member

@nixel2007 nixel2007 Dec 8, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Потыкал bootprint, страшненький :)
может привычный swagger-ui использовать?
https://github.com/swagger-api/swagger-ui
у него есть standalone-запуск

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Документирование OpenApi
3 participants