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

1. Обзор​

Описание RESTful API играет важную роль в документации. Одним из распространенных инструментов, используемых для документирования REST API, является Swagger 2 . Однако один полезный атрибут, используемый для добавления описания, устарел. В этом руководстве мы найдем решение для устаревшего атрибута описания с помощью Swagger 2 и OpenAPI 3 и покажем, как их можно использовать для описания приложения Spring Boot REST API.

2. Описание API​

По умолчанию Swagger создает пустое описание для имени класса REST API. Поэтому нам нужно указать подходящую аннотацию для описания REST API. Мы можем либо использовать Swagger 2 с аннотацией @Api , либо использовать аннотацию @Tag в OpenAPI 3.

3. Чванство 2​

1. Обзор​

При создании документации Swagger нам часто приходится скрывать конечные точки от конечных пользователей. Чаще всего это делается, когда конечная точка еще не готова. Кроме того, у нас могут быть некоторые частные конечные точки, которые мы не хотим раскрывать.

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

2. Скрытие конечной точки с помощью @ApiIgnore​

Аннотация @ApiIgnore позволяет скрыть конечную точку . Давайте добавим эту аннотацию для конечной точки в наш контроллер:

1. Введение​

В этом руководстве мы увидим, как объявлять даты в файле OpenAPI, в данном случае реализованном с помощью Swagger . Это позволит нам стандартизированно управлять датами ввода и вывода при вызове внешних API.

2. Чванство против ОАГ​

Swagger — это набор инструментов, реализующих спецификацию OpenAPI (OAS), независимый от языка интерфейс для документирования RESTful API. Это позволяет нам понять возможности любого сервиса без доступа к исходному коду.

Для реализации этого в нашем проекте будет файл, обычно YAML или JSON , описывающий API с использованием OAS. Затем мы будем использовать инструменты Swagger для:

1. Введение​

В этой статье мы будем использовать проекты Swagger Codegen и OpenAPI Generator для создания клиентов REST из файла спецификации OpenAPI/Swagger .

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

Мы будем использовать пример API Swagger Petstore для всего.

2. Создайте клиент REST с помощью Swagger Codegen​

1. Обзор​

В этом руководстве мы кратко рассмотрим аннотации Swagger @ApiParam и @ApiModelProperty . Кроме того, мы сравним эти аннотации и определим правильное использование для каждого из них.

2. Ключевое отличие​

Проще говоря , аннотации @ApiParam и @ApiModelProperty добавляют различные метаданные в Swagger. Аннотация @ApiParam предназначена для параметров запроса ресурса API, а @ApiModelProperty — для свойств модели.

3. @Апипарам​

1. Обзор​

Swagger — это набор спецификаций для документирования и описания REST API. Он также предоставляет примеры значений для параметров конечной точки.

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

2. Укажите массив строк в качестве параметров тела в Swagger​

Проблема возникает, когда мы хотим указать массив строк в качестве параметров тела в Swagger.