swagger.js

/* eslint-disable @typescript-eslint/no-require-imports */

const fs = require('fs');
const packageJson = require('./package.json');
const swaggerJsdoc = require('swagger-jsdoc');

const options = {
  definition: {
    openapi: '3.0.0',
    info: {
      title: 'Boltz API',
      version: packageJson.version,
      description:
        '## ⚠️ DO NOT INTEGRATE THIS API DIRECTLY ⚠️\n\n' +
        'All Boltz integrations must use an official SDK or client library. ' +
        'They handle the cryptography, the swap state machine, and the ' +
        'fund-recovery edge cases for you. Integrating the API directly ' +
        'is error-prone and will lead to **loss of funds**.\n\n' +
        'Official SDK list available ' +
        '[here](https://api.docs.boltz.exchange/libraries.html)!',
    },
  },
  apis: [
    './lib/api/v2/routers/InfoRouter.ts',
    './lib/api/v2/routers/SwapRouter.ts',
    './lib/api/v2/routers/LightningRouter.ts',
    './lib/api/v2/routers/ChainRouter.ts',
    './lib/api/v2/routers/QuoteRouter.ts',
    './lib/api/v2/routers/NodesRouter.ts',
    './lib/api/v2/routers/CommitmentRouter.ts',
    './lib/api/v2/routers/ReferralRouter.ts',
    './lib/api/v2/routers/RouterBase.ts',
  ],
  failOnErrors: true,
};

const specs = swaggerJsdoc(options);
specs.servers = [
  {
    url: 'https://api.boltz.exchange/v2',
    description: 'Mainnet',
  },
  {
    url: 'http://localhost:9006/v2',
    description: 'Regtest',
  },
];

fs.writeFileSync('swagger-spec.json', JSON.stringify(specs, undefined, 2));