Оё шумо воситаи Swagger-ро барои ҳуҷҷатгузории API истифода бурдаед?

Бале, ман Node.js лойиҳаларда API-лар учун Swagger-дан фойдаланганман. Swagger OpenAPI спецификацияси ёрдамида API структурасини тасвирлашга imkon беради, бу интерфейсларни тушуниш ва синовдан ўтказишни осонлаштиради. Одатда, коддаги шарҳлардан ҳужжатлар яратиш учун 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 ҳужжатларини автоматик равишда яратиш ва янгилаш имконини беради.