Z
Автоматически генерировать это как? Это вообще не относится к ide.
К примеру под asp net есть разные модули которых можно подключить и дальше они генерирует yaml файл.
Size: a a a
2021 January 08
G
Z
German
При добавлении кода (API)-шек, чтобы формировался yaml-файл (хотя бы скелет)
А вы на чем пишите?
Z
И что пишите?
О
German
Кто-нибудь хорошо разбирается в Swagger или аналоге? Есть несколько вопросов:
1. Как установить дефолтную страницу Swagger-а, чтобы открывался нужный yaml-файл? Сваггер установлен в виде готового докер-контейнера. Хостовая ОС - Убунту.
2. Можно ли сделать на сваггере страницу со ссылками на другие страницы с описанием API? Как оглавление.
3. Как подружить swagger с IDE-шками, чтобы можно было автоматически генерировать API? Интересуют конкретные примеры
1. Как установить дефолтную страницу Swagger-а, чтобы открывался нужный yaml-файл? Сваггер установлен в виде готового докер-контейнера. Хостовая ОС - Убунту.
2. Можно ли сделать на сваггере страницу со ссылками на другие страницы с описанием API? Как оглавление.
3. Как подружить swagger с IDE-шками, чтобы можно было автоматически генерировать API? Интересуют конкретные примеры
@protimaru у него есть опыт работы с swagger
Z
Примерно также отвечают 99.99% из всех
Потому что 99.99% народа с подобными вопросами не читают документацию
G
German
По второму вопросу хочу получить что-то такое. Главную страницу со ссылками на остальные страницы с описаниями.
Пока нашёл только ref-ы на другие yaml-ы. То есть, одна страница с кучей описаний API, которые можно структурированно разложить в различные файлы.
Нашёл, что можно давать гиперссылки через externalDocs, но он может быть только один в пределах документа.
Пытался указать внутри объектов Url: targetsite, не получалось
Пока нашёл только ref-ы на другие yaml-ы. То есть, одна страница с кучей описаний API, которые можно структурированно разложить в различные файлы.
Нашёл, что можно давать гиперссылки через externalDocs, но он может быть только один в пределах документа.
Пытался указать внутри объектов Url: targetsite, не получалось
G
А вы на чем пишите?
Коллеги пишут на Java (Spring) + React. Админ не может настроить связку. Поэтому запрашиваю посильную помощь.
G
И что пишите?
Веб-система.
- Получает информацию из 4 поставщиков.
- Передаёт информацию в 20+ потребителей.
- Есть внутренние сервисные API.
- Есть куча endpoint-ов
- Получает информацию из 4 поставщиков.
- Передаёт информацию в 20+ потребителей.
- Есть внутренние сервисные API.
- Есть куча endpoint-ов
Z
German
Коллеги пишут на Java (Spring) + React. Админ не может настроить связку. Поэтому запрашиваю посильную помощь.
Получается у вас уже в проекте есть необходимые зависимости для генерации yaml файла так?
G
Получается у вас уже в проекте есть необходимые зависимости для генерации yaml файла так?
Вот тут, честно говоря, немного плаваю. Скорее всего есть. Буду внимательно изучать
G
Орынбай
@protimaru у него есть опыт работы с swagger
Спасибо
Z
German
Вот тут, честно говоря, немного плаваю. Скорее всего есть. Буду внимательно изучать
Мда. Предположим что есть и yaml генерируется для вашего сервиса. Стандартно описывает все доступные методы и сущности. Но то что вы привели пример которую хотите вы сами должны рисовать ручками. И настроит генератор чтобы сгенерировано yaml файл необходимом виде.
Z
German
Вот тут, честно говоря, немного плаваю. Скорее всего есть. Буду внимательно изучать
G
Мда. Предположим что есть и yaml генерируется для вашего сервиса. Стандартно описывает все доступные методы и сущности. Но то что вы привели пример которую хотите вы сами должны рисовать ручками. И настроит генератор чтобы сгенерировано yaml файл необходимом виде.
Yaml будем дописывать.
Мне сейчас главное, чтобы:
- При изменении API не забывали изменять его описание.
- При добавлении API не забывали делать его описание.
Мне сейчас главное, чтобы:
- При изменении API не забывали изменять его описание.
- При добавлении API не забывали делать его описание.
Z
German
Yaml будем дописывать.
Мне сейчас главное, чтобы:
- При изменении API не забывали изменять его описание.
- При добавлении API не забывали делать его описание.
Мне сейчас главное, чтобы:
- При изменении API не забывали изменять его описание.
- При добавлении API не забывали делать его описание.
Вам сначала немножко нужно потрудиться и настроит генератор. И сборку проекта. Дальше при каждой сборке будет автоматом.
G
Вам сначала немножко нужно потрудиться и настроит генератор. И сборку проекта. Дальше при каждой сборке будет автоматом.
Понял, отправился в Google
G
German
Но этот вопрос пока открыт, как сделать MainPage
Z
German
Но этот вопрос пока открыт, как сделать MainPage
Переделать main page у свагера.