Как мы можем отобразить единый API внутри пользовательского интерфейса Swagger? См. Приложенный снимок экрана - PullRequest
0 голосов
/ 27 мая 2020

Я пытаюсь получить документацию по Swagger API, как на прилагаемом снимке экрана. У меня крутая конечная точка. Я хочу настроить пользовательский интерфейс Swagger для отображения документа API следующим образом:

  1. Имя API
  2. Описание API
  3. Конечная точка действия
  4. Пользовательский интерфейс Swagger - Вставить Пользовательский интерфейс Swagger здесь, чтобы опробовать единый API через URL-адрес конечной точки
  5. Поля API
  6. Запрос API JSON
  7. Ответ API JSON

Swagger API documentation with description and single API

Я пытался настроить пользовательский интерфейс Swagger в ASP. Net Core, Angular и React. Пока не повезло. Пожалуйста, дайте мне знать, выполнили ли вы такую ​​настройку или достигли ее.

1 Ответ

0 голосов
/ 28 мая 2020

Чтобы отобразить полную документацию вашего API-интерфейса swagger для клиента или при использовании sh, все, что вам нужно сделать, это добавить XML комментариев ко всем методам действий вашего API. Просто go по методу, нажмите Enter и трижды введите forward sla sh. XML появляются комментарии.

...