Files
parcer/server/src/swagger/config.ts

34 lines
813 B
TypeScript
Raw Normal View History

2024-10-28 23:27:40 +05:30
import swaggerJSDoc from 'swagger-jsdoc';
import path from 'path';
const options = {
definition: {
openapi: '3.0.0',
info: {
title: 'Maxun API Documentation',
version: '1.0.0',
2024-10-29 00:02:33 +05:30
description: 'API documentation for Maxun (https://github.com/getmaxun/maxun)',
2024-10-28 23:27:40 +05:30
},
2024-10-28 23:45:15 +05:30
components: {
securitySchemes: {
2024-10-28 23:59:07 +05:30
api_key: {
2024-10-28 23:45:15 +05:30
type: 'apiKey',
in: 'header',
name: 'x-api-key',
description: 'API key for authorization. You can find your API key in the "API Key" section on Maxun Dashboard.',
},
},
},
security: [
{
2024-10-28 23:59:07 +05:30
api_key: [], // Apply this security scheme globally
2024-10-28 23:45:15 +05:30
},
],
2024-10-28 23:27:40 +05:30
},
apis: [path.join(__dirname, '../api/*.ts')],
};
const swaggerSpec = swaggerJSDoc(options);
export default swaggerSpec;