Как вы можете проектировать и документировать API с помощью OpenAPI (Swagger)?

Question

Accepted Answer

**Инструменты:**

*

`swagger-jsdoc`

: Создание документов из комментариев.
*

`swagger-ui-express`

: Подавать документы в Express.
* Редакторы: Swagger Editor, Stoplight, Postman.

**Базовая настройка:**

```javascript
const swaggerUi = require('swagger-ui-express');
const swaggerJsdoc = require('swagger-jsdoc');

const options = {
  definition: { openapi: '3.0.0', info: { title: 'API', version: '1.0.0' } },
  apis: ['./routes/*.js']
};

const specs = swaggerJsdoc(options);
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(specs));
```

**Преимущества:**

* Самодокументируемые API.
* Генерация клиентского SDK.
* Разработка по контракту.

---

## Итог

Ключевой вывод для интервью: как можно проектировать и документировать API с помощью OpenAPI (Swagger)?