ReSQL.ru
     
powered by simpleCommunicator - 2.0.30     © 2024 Programmizd 02
Мобильная версия    Контакт    Правила    FAQ    Помощь
Map
Доб. в избранное | Игнор. тему | Прикреп. тему | Пометить прочит. / непрочит. | Фильтр
Форумы / Java [игнор отключен] [закрыт для гостей] / Как указать Swagger-у контекст приложения rest-сервиса?
25 сообщений из 47, страница 1 из 2
  1  все
Как указать Swagger-у контекст приложения rest-сервиса?
    #40052080
XEugene
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
XEugene
Участник
Код: java
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
13.
14.
15.
16.
@ApplicationPath("/docs")
@OpenAPIDefinition(
        info = @Info(
                title = "Title of service",
                description = "Description of service",
                version = "1.0"
        )
)
public class Swagger extends Application {
    @Override
    public Set<Class<?>> getClasses() {
        Set<Class<?>> resources = new HashSet<Class<?>>();
        resources.add(OpenApiResource.class);
        return resources;
    }
}



Собирается как war и деплоится на вебсферу.

Трудность возникла с тем, чтобы указать сваггеру тот сервис, который он должен документировать.

Мой сервис https://localhost:9643/employees

Кладу в src/main/reesources файл openapi.yaml такого содержания:
авторprettyPrint: true
cacheTTL: 0
openAPI:
servers:
- url: https://localhost:9643/employees
info:
version: '1.0'
title: Swagger application

Отправляю в браузере или soup ui get-запрос на https://localhost:9643/employees/docs/openapi.json
получаю 404 Not Found


Пробую также сконфигурировать это в аннотации
Код: java
1.
2.
3.
4.
@ApplicationPath("/docs")
@OpenAPIDefinition(
        servers = @Server(url="https://localhost:9643/employees"),
        info = @Info(



Результат такой же.
...
Рейтинг: 0 / 0
09.03.2021, 19:21
| Ответить | Цитировать | Написать  
Как указать Swagger-у контекст приложения rest-сервиса?
    #40052238
XEugene
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
XEugene
Участник
Разобрался, оказывается этот класс нужно помещать в тот же класс, где сервис. И никаких урлов указывать не нужно.
...
Рейтинг: 0 / 0
10.03.2021, 12:31
| Ответить | Цитировать | Написать  
Как указать Swagger-у контекст приложения rest-сервиса?
    #40053009
Фотография asv79
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
asv79
Участник
кто то еще юзает это юзлесс дерьмище?
мало прогерам работы ,еще вот этими какашками надо сверху присыпать)
юзайте конфлюенс - а вот это все это какая то бессмыслица- которую еще и поддерживать надо
...
Рейтинг: 0 / 0
12.03.2021, 19:59
| Ответить | Цитировать | Написать  
Как указать Swagger-у контекст приложения rest-сервиса?
    #40053028
Lelouch
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Lelouch
Участник
asv79
кто то еще юзает это юзлесс дерьмище?
мало прогерам работы ,еще вот этими какашками надо сверху присыпать)
юзайте конфлюенс - а вот это все это какая то бессмыслица- которую еще и поддерживать надо


Как только конфлюенс научится генерировать:
1) UI для взаимодействия с сервисом https://petstore.swagger.io/?_ga=2.116214342.1304960575.1615574173-1322946365.1615574173 (правда конкретно этот сервис не из OpenAPI сгенерирован, но по OpenAPI тоже можно)
2) Код клиента: https://swagger.io/tools/swagger-codegen/
то сразу перейду
...
Рейтинг: 0 / 0
12.03.2021, 21:38
| Ответить | Цитировать | Написать  
Как указать Swagger-у контекст приложения rest-сервиса?
    #40054846
XEugene
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
XEugene
Участник
XEugene
Разобрался, оказывается этот класс нужно помещать в тот же класс, где сервис . И никаких урлов указывать не нужно.

Опечатка - помещать в то же приложение, конечно.
...
Рейтинг: 0 / 0
18.03.2021, 10:41
| Ответить | Цитировать | Написать  
Как указать Swagger-у контекст приложения rest-сервиса?
    #40055538
Фотография asv79
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
asv79
Участник
Lelouch
asv79
кто то еще юзает это юзлесс дерьмище?
мало прогерам работы ,еще вот этими какашками надо сверху присыпать)
юзайте конфлюенс - а вот это все это какая то бессмыслица- которую еще и поддерживать надо


Как только конфлюенс научится генерировать:
1) UI для взаимодействия с сервисом https://petstore.swagger.io/?_ga=2.116214342.1304960575.1615574173-1322946365.1615574173 (правда конкретно этот сервис не из OpenAPI сгенерирован, но по OpenAPI тоже можно)
2) Код клиента: https://swagger.io/tools/swagger-codegen/
то сразу перейду

давай посчитай сколько там переходов на твой говно свагер? я вангую будет 0 ,если не считать самих разрабов сервиса
пойми ты вся эта дичь клиентам не впилась в хер- им нужно человеческое описание API
я сейчас отвечаю за API нашего сервиса и там есть свагер - а по факту пишут люди как и что ?я им говорю ну вот ссылка на свагер
по факту пришлось к ним ехать и настраивать их ПО
свагер - это тупо фуфло ,собственно как и все остальное ,никто не опишет сервис лучше,чем разраб его писавший- причем самое смешное я писал недавно API и описал его ,как мне казалось,что будет понятно даже байдену- но по факту сейчас с прода прилетают обращения нон стоп- и никакой свагер тебе это не поможет)
...
Рейтинг: 0 / 0
20.03.2021, 20:24
| Ответить | Цитировать | Написать  
Как указать Swagger-у контекст приложения rest-сервиса?
    #40055574
Lelouch
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Lelouch
Участник
asv79
Lelouch
пропущено...


Как только конфлюенс научится генерировать:
1) UI для взаимодействия с сервисом https://petstore.swagger.io/?_ga=2.116214342.1304960575.1615574173-1322946365.1615574173 (правда конкретно этот сервис не из OpenAPI сгенерирован, но по OpenAPI тоже можно)
2) Код клиента: https://swagger.io/tools/swagger-codegen/
то сразу перейду

давай посчитай сколько там переходов на твой говно свагер? я вангую будет 0 ,если не считать самих разрабов сервиса
пойми ты вся эта дичь клиентам не впилась в хер- им нужно человеческое описание API
я сейчас отвечаю за API нашего сервиса и там есть свагер - а по факту пишут люди как и что ?я им говорю ну вот ссылка на свагер
по факту пришлось к ним ехать и настраивать их ПО
свагер - это тупо фуфло ,собственно как и все остальное ,никто не опишет сервис лучше,чем разраб его писавший- причем самое смешное я писал недавно API и описал его ,как мне казалось,что будет понятно даже байдену- но по факту сейчас с прода прилетают обращения нон стоп- и никакой свагер тебе это не поможет)


1) Ну то есть api вы описали хреново?)
2) Сравнение swagger с Вики страницей это вообще сильно) Сразу видно специалиста.
3) Какие «переходы» мне надо «посчитать»?
4) ну и если мы приплетаем личный опыт - у нас на всех проектах swagger, а описание api в confluence я за последние 5 лет видел только 2 раза, и оба раза помимо описания был и swagger (по которому разобраться было в разы проще, чем по графоманству в confluence). Да и в этих случаях в confluence описывали сценарии использования api , а не тупо перечисляли методы и параметры.
...
Рейтинг: 0 / 0
21.03.2021, 01:39
| Ответить | Цитировать | Написать  
Как указать Swagger-у контекст приложения rest-сервиса?
    #40055576
Lelouch
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Lelouch
Участник
asv79,

BTW из OpenApi можно даже в confluence страницы генерировать:
1) https://marketplace.atlassian.com/apps/1219386/open-api-swagger-integration?hosting=cloud&tab=overview
2) https://github.com/starlightknight/swagger-confluence
Ну то есть можно, как нормальный человек, вести доку рядом с кодом и получать требуемые артефакты из неё.
...
Рейтинг: 0 / 0
21.03.2021, 02:12
| Ответить | Цитировать | Написать  
Как указать Swagger-у контекст приложения rest-сервиса?
    #40055596
Фотография asv79
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
asv79
Участник
Lelouch

3) Какие «переходы» мне надо «посчитать»?

клиентские на свой чудо свагер и убедиться что туда никто кроме разрабов ваших же никто не заходит.
Еще раз для тех кто в танке- не может пока свагер нормально описать апи ,не поймет его никогда клиент и по факту это мартышкин труд.
...
Рейтинг: 0 / 0
21.03.2021, 12:42
| Ответить | Цитировать | Написать  
Как указать Swagger-у контекст приложения rest-сервиса?
    #40055597
Фотография asv79
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
asv79
Участник
Lelouch

Ну то есть можно, как нормальный человек, вести доку .

и свагер для этого даром не нужен)
...
Рейтинг: 0 / 0
21.03.2021, 12:45
| Ответить | Цитировать | Написать  
Как указать Swagger-у контекст приложения rest-сервиса?
    #40055602
Lelouch
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Lelouch
Участник
asv79
Lelouch

Ну то есть можно, как нормальный человек, вести доку .

и свагер для этого даром не нужен)


Вы цитируйте до конца фразы пожалуйста) там еще есть "рядом с кодом"
Нужен ли для этого swagger - это вопрос. Но confluence этого точно не позволяет.
...
Рейтинг: 0 / 0
21.03.2021, 12:56
| Ответить | Цитировать | Написать  
Как указать Swagger-у контекст приложения rest-сервиса?
    #40055623
Фотография asv79
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
asv79
Участник
Lelouch
asv79
пропущено...

и свагер для этого даром не нужен)


Вы цитируйте до конца фразы пожалуйста) там еще есть "рядом с кодом"
Нужен ли для этого swagger - это вопрос. Но confluence этого точно не позволяет.

При чем тут конфлюенс вообще не понятно- вы можете описание своего апи прибить гвоздями хоть себе на спину и ходить клиентам показывать)
ну а по теме->
Тут где то был человек и приводил статистику перехода на свагер клиентами и количество этих переходов было равно нулю
...
Рейтинг: 0 / 0
21.03.2021, 16:12
| Ответить | Цитировать | Написать  
Как указать Swagger-у контекст приложения rest-сервиса?
    #40055690
asutp2
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
asutp2
Участник
asv79
пойми ты вся эта дичь клиентам не впилась в хер- им нужно человеческое описание API
ох, как же я тебя понимаю.
...
Рейтинг: 0 / 0
21.03.2021, 23:07
| Ответить | Цитировать | Написать  
Как указать Swagger-у контекст приложения rest-сервиса?
    #40055691
Фотография mayton
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
mayton
Участник
Swagger - это рак который на "безрыбье является рыбой". Грубо говоря он - плох. Но альтернатив ему пока нет.
...
Рейтинг: 0 / 0
21.03.2021, 23:23
| Ответить | Цитировать | Написать  
Как указать Swagger-у контекст приложения rest-сервиса?
    #40055723
PetroNotC Sharp
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
PetroNotC Sharp
Участник
asv79,
Ты используй под словом "клиент" лучше слово "заказчик".
Нужен ли сабж заказчику? Если у него отдел IT есть, это одно. Если нет это другое.
Сабж это автоматизация.
Спринг тоже автоматизация.
...
Рейтинг: 0 / 0
22.03.2021, 07:34
| Ответить | Цитировать | Написать  
Как указать Swagger-у контекст приложения rest-сервиса?
    #40055724
PetroNotC Sharp
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
PetroNotC Sharp
Участник
mayton
Swagger - это рак который на "безрыбье является рыбой". Грубо говоря он - плох. Но альтернатив ему пока нет.

Альтернатива1

авторМы смогли узнать, какие операции были доступны и какими элементами они управляют. И нам не нужно было знать структуру URI. Метаданные сказали нам, где искать эти переходы RESTful. Это означает, что сервер может изменять URI, и это не повлияет на нашу способность взаимодействовать со службой.
https://spring.io/blog/2014/07/14/spring-data-rest-now-comes-with-alps-metadata
...
Рейтинг: 0 / 0
22.03.2021, 07:39
| Ответить | Цитировать | Написать  
Как указать Swagger-у контекст приложения rest-сервиса?
    #40055745
PetroNotC Sharp
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
PetroNotC Sharp
Участник
Альтернатива2
Spring HATEOAS
http://spring-projects.ru/understanding/hateoas/
...
Рейтинг: 0 / 0
22.03.2021, 10:13
| Ответить | Цитировать | Написать  
Как указать Swagger-у контекст приложения rest-сервиса?
    #40055849
Bsplesk
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Bsplesk
Гость
mayton,

Есть старый, добрый крОвавый Enterprise SOAP (WSDL/XML/XSD).
Но вот инструменты для него стоят денеХ, но у нас очень любят халяву.
У кого денеХ нет, тот использует либо халявный Swagger, либо пишет пример использования на туалетной бумажке в confluence, а потом когда оказывается, что бумажка давным, давно протухла использует её по назначению и скачет верхом с шилом в . ко всем потребителям сервиса настраивать их системы.

Альтернативы есть всегда - к примеру поддерживать готовые библиотеки под языки, которые используют потребителя сервиса + туалетную бумажку с описанием, как использовать и какие вызовы api использовать, что выполнить заложенный процесс.
...
Рейтинг: 0 / 0
22.03.2021, 13:34
| Ответить | Цитировать | Написать  
Как указать Swagger-у контекст приложения rest-сервиса?
    #40055855
Bsplesk
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Bsplesk
Гость
Желаете человеческое описание типа https://github.com/hhru/api ?
Это стоит отдельных денег.
...
Рейтинг: 0 / 0
22.03.2021, 13:48
| Ответить | Цитировать | Написать  
Как указать Swagger-у контекст приложения rest-сервиса?
    #40055873
PetroNotC Sharp
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
PetroNotC Sharp
Участник
Bsplesk
Желаете человеческое описание типа https://github.com/hhru/api ?
Это стоит отдельных денег.
хороший пример.
+1
...
Рейтинг: 0 / 0
22.03.2021, 14:38
| Ответить | Цитировать | Написать  
Как указать Swagger-у контекст приложения rest-сервиса?
    #40056036
Bsplesk
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
Bsplesk
Гость
PetroNotC Sharp,

Ну как сказать....., конечно, гораздо лучше confluence, только вот разработчики читать не любят.
Разработчикам удобна либа или тотже swagger контракт, по которому можно сгенерить классы/либу в один клик и начать работать.
Подтверждение:


И как в любой человекочитаемой документации присутствуют пробелы и неточности (в отличии от генеренного контракта).



https://habr.com/en/company/hh/blog/303168/
...
Рейтинг: 0 / 0
22.03.2021, 19:44
| Ответить | Цитировать | Написать  
Как указать Swagger-у контекст приложения rest-сервиса?
    #40056046
Фотография mayton
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
mayton
Участник
А при чем тут Swagger? Это относится к технолгии jwt-tokens

https://jwt.io/introduction
...
Рейтинг: 0 / 0
22.03.2021, 20:07
| Ответить | Цитировать | Написать  
Как указать Swagger-у контекст приложения rest-сервиса?
    #40056090
PetroNotC Sharp
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
PetroNotC Sharp
Участник
Bsplesk,
Предлагаю разобрать более подробно два ваших примера.
- пример генерации прокси классов как в SOAP (зачем они вообще)
- не соответствие документации самому API.
Например, в soap генерация нужна так как отправляется вообще xml)))
...
Рейтинг: 0 / 0
23.03.2021, 07:54
| Ответить | Цитировать | Написать  
Как указать Swagger-у контекст приложения rest-сервиса?
    #40056281
PetroNotC Sharp
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
PetroNotC Sharp
Участник
Bsplesk,
авторНу как сказать....., конечно, гораздо лучше confluence, только вот разработчики читать не любят.
Разработчикам удобна либа или тотже swagger контракт, по которому можно сгенерить классы/либу в один клик и начать работать.
Вот пример где мне нужна либа и описание человеческого api, но никак не генератор и сваггер и...
Андроид с java +либа retrofit
- пишем вызов
Код: java
1.
2.
3.
4.
5.
6.
Retrofit ret = new Retrofit.Builder(....
IServerAPI iserv = ret.create(IServerAPI.class);
Call<Integer> call = iserv.checkAutorized();
try
Response<Integer> res = call.execute();
.....


Далее описываем интерфейс IServerAPI по ДОКУМЕНТАЦИИ.
Че там генерировать?
Если генерировать то SOAP будет.
Движемся по кругу.
Имхо
...
Рейтинг: 0 / 0
23.03.2021, 15:31
| Ответить | Цитировать | Написать  
Как указать Swagger-у контекст приложения rest-сервиса?
    #40056329
chpasha
Скрыть профиль Поместить в игнор-лист Сообщения автора в теме
chpasha
Участник
PetroNotC Sharp
Че там генерировать?

ну представь себе, что у тебя в этом IServerAPI двести методов. руками ты их задолбаешься писать, тут бы как раз генератор и помог - сразу тебе этот IServerAPI сгенерил. А когда 5,5 методов то да, можно и руками
...
Рейтинг: 0 / 0
23.03.2021, 16:30
| Ответить | Цитировать | Написать  
25 сообщений из 47, страница 1 из 2
  1  все
Форумы / Java [игнор отключен] [закрыт для гостей] / Как указать Swagger-у контекст приложения rest-сервиса?
Целевая тема:
Создать новую тему:
Автор:
Закрыть
Цитировать
Найденые пользователи ...
Разблокировать пользователей ...
Читали тему (0):
Читали форум (0):
Пользователи онлайн (0):
Польз. соглашение
NoSQL.ru, Чат Кролика       Пашэ: Рисунки, Чат       Фотоальбом: Участники, Встречи
Закрыть
start [/forum/topic.php?fid=59&msg=40055690&tid=2120499]:
 0ms
get settings:
 24ms
get forum list:
 13ms
check forum access:
 2ms
check topic access:
 2ms
track hit:
 55ms
get topic data:
 11ms
get forum data:
 3ms
get page messages:
 594ms
get tp. blocked users:
 1ms
others: 18ms
total:  723ms
созд. / загр.: 723ms
x
x
Закрыть


Просмотр
0 / 0
Close
Debug Console [Select Text]