16 записей с тегом "Swagger"

1. Введение​

В этом кратком руководстве мы увидим, как настроить пользовательский интерфейс Swagger для включения веб-токена JSON (JWT) при вызове нашего API.

2. Зависимости Maven​

В этом примере мы будем использовать springfox-boot-starter , который включает в себя все необходимые зависимости для начала работы с Swagger и пользовательским интерфейсом Swagger. Давайте добавим его в наш файл pom.xml :

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

1. Обзор​

Мы можем использовать Swagger UI в качестве платформы для удобной визуализации интерфейсов API и взаимодействия с ними. Это мощный инструмент для создания структур API с минимальной необходимой настройкой.

В этой статье мы сосредоточимся на использовании Swagger с API REST Spring Boot . В частности, мы рассмотрим различные способы скрытия поля запроса в пользовательском интерфейсе Swagger.

2. Введение​

Для простоты мы создадим базовое приложение Spring Boot и изучим API с помощью пользовательского интерфейса Swagger.

1. Обзор​

Пользовательский интерфейс Swagger позволяет нам просматривать информацию о наших службах REST. Это может быть очень удобно для разработки. Однако из соображений безопасности мы можем не разрешить такое поведение в общедоступных средах.

В этом коротком уроке мы рассмотрим, как отключить Swagger в рабочей среде .

2. Конфигурация чванства​

Чтобы настроить Swagger с помощью Spring , мы определяем его в bean-компоненте конфигурации.

1. Обзор​

В этом руководстве мы узнаем, как документировать перечисление в Swagger с помощью плагина swagger-maven и проверять сгенерированный документ JSON в редакторе swagger.

2. Что такое чванство?​

Swagger — это инструмент с открытым исходным кодом для определения API-интерфейсов на основе отдыха. В современном мире большинство организаций переходят на микросервисы и первый подход к API. Swagger очень удобен для разработки и документирования API. Он также предоставляет различные инструменты, такие как редактор Swagger, пользовательский интерфейс Swagger и Swagger CodeGen, для помощи в разработке API.

Кроме того, Swagger — это реализация спецификаций OpenAPI или OAS , которая определяет набор стандартов для разработки остальных API; следовательно, это помогает организациям по всему миру стандартизировать процесс написания API.

1. Обзор​

В этом руководстве мы увидим, как мы можем использовать аннотации Swagger, чтобы сделать нашу документацию более описательной. Мы узнаем, как добавить описание к различным частям API, таким как методы, параметры и коды ошибок. Мы также увидим, как добавить примеры запроса/ответа.

2. Настройка проекта​

Мы создадим простой API продуктов, который предоставляет методы для создания и получения продуктов.

Чтобы создать REST API с нуля, мы можем следовать этому руководству из Spring Docs, чтобы создать веб-службу RESTful с использованием Spring Boot.

1. Обзор​

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

2. Вызов​

Как и другие веб-ресурсы, REST API часто защищены. Таким образом, потребитель службы (такой как пользовательский интерфейс Swagger) должен не только сам обрабатывать HTTP-вызов, но и предоставлять информацию для аутентификации поставщику службы.

Keycloak — это сервер IAM, который позволяет выполнять аутентификацию и авторизацию за пределами реализации поставщика услуг. Это часть архитектуры, как показано на следующей диаграмме:

1. Обзор​

В этом руководстве мы изучим несколько методов настройки Swagger в приложении Spring Boot , чтобы скрыть пути, открытые BasicErrorController .

2. Целевой проект​

В этой статье мы не будем рассматривать создание базовой конфигурации для запуска Spring Boot и Swagger-UI. Мы можем либо использовать уже настроенный проект, либо следовать руководству по настройке Swagger 2 с помощью Spring REST API , чтобы создать базовую конфигурацию.

3. Проблема​

1. Обзор​

В этом руководстве мы познакомимся с различными способами создания PDF-файла из документации Swagger API. Чтобы ознакомиться со Swagger, обратитесь к нашему руководству по настройке Swagger 2 с помощью Spring REST API .

2. Создайте PDF с помощью плагинов Maven​

Первое решение для создания PDF-файла из документации Swagger API основано на наборе подключаемых модулей Maven. При таком подходе мы получим файл PDF при создании проекта Java.

Шаги для создания желаемого PDF-файла включают в себя применение нескольких подключаемых модулей в определенном порядке во время сборки Maven . Плагины должны быть настроены на выбор ресурсов и распространение выходных данных предыдущих фаз в качестве входных данных следующей фазы. Итак, давайте посмотрим, как работает каждый из них.

1. Обзор​

Когда мы хотим сгенерировать проверки с помощью Swagger, мы обычно используем базовые спецификации . Однако нам может понадобиться добавить пользовательские аннотации проверки Spring .

В этом учебном пособии рассказывается, как создавать модели и REST API с использованием этих проверок, уделяя особое внимание генератору сервера OpenAPI, а не валидаторам ограничений.

2. Настройка​

Для настройки мы будем использовать предыдущее руководство ForEach для создания сервера из определения OpenAPI 3.0.0 . Далее мы собираемся добавить несколько пользовательских аннотаций проверки вместе со всеми необходимыми зависимостями.

1. Введение​

Спецификация OpenAPI (ранее спецификация Swagger) стандартизирует язык документации REST API и не зависит от платформы. Мы можем создавать документы OpenAPI в форматах YAML или JSON .

С другой стороны, Swagger — это набор инструментов для реализации и работы со стандартом. Некоторые из них бесплатны, некоторые с открытым исходным кодом, а некоторые являются коммерческими. Эти инструменты помогают нам проектировать, документировать и использовать REST API.

В этой статье мы узнаем, как форматировать текстовые описания в наших документах OpenAPI.

2. Редакторы OpenAPI​