API үчүн Swagger инструментин документтөө үчүн колдондуңузбу?

Ооба, мен Node.js долбоорлорунда API документтештирүү үчүн Swagger колдонгом. Swagger OpenAPI спецификациясы аркылуу API түзүмүн сүрөттөйт, бул интерфейстерди түшүнүүнү жана тестирлөөнү жеңилдетет. Мен көбүнчө swagger-jsdoc пакети аркылуу коддогу комментарийлерден документ түзүп, swagger-ui-express аркылуу интерактивдүү документти көрсөтөм.

Express тиркемесинде Swaggerди кантип интеграциялоо мисалы:

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

const app = express();

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));

app.listen(3000, () => console.log('Сервер ишке кирди'));

Бул API документтештирүүнү автоматтык түрдө түзүүгө жана жаңыртууга мүмкүндүк берет.