Swagger UI: удобный интерфейс для работы с API

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

Примеры кода:

1. Настройка Swagger UI:

javascript
const express = require('express');
const swaggerUi = require('swagger-ui-express');
const YAML = require('yamljs');
const swaggerDocument = YAML.load('./swagger.yaml');
const app = express();
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));

В этом примере мы используем библиотеку `swagger-ui-express` для настройки Swagger UI в нашем приложении Express. Мы загружаем файл Swagger с помощью библиотеки `yamljs` и передаем его в middleware Swagger UI.

2. Добавление аннотации Swagger в код:

javascript
/**
* @swagger
* /users/me:
*   get:
*     summary: Get the current user profile
*     description: This endpoint retrieves the user's profile information.
*     tags:
*       - Users
*     produces:
*       - application/json
*     responses:
*       200:
*         description: The user information
*         schema:
*           type: object
*           properties:
*             id:
*               type: integer
*             name:
*               type: string
*             email:
*               type: string
*/
app.get('/users/me', (req, res) => {
  // ...
});

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

3. Использование Swagger UI для тестирования API:


На этой картинке показан пример Swagger UI, который позволяет пользователю протестировать API, просмотреть документацию и просмотреть схему данных. Он обеспечивает удобный и простой способ взаимодействия с API и ускоряет разработку и отладку приложений, которые используют этот API.