faster-auto
Version:
A fast and lightweight framework for building RESTful APIs with Sequelize and Node.js. Supports automatic model loading, flexible query APIs, and built-in Swagger documentation.
106 lines (105 loc) • 3.58 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.generateSwaggerSpecFromSchemas = void 0;
function generateSwaggerSpecFromSchemas(schemas, apiPrefix = '/api') {
const paths = {};
const componentsSchemas = {};
for (const [name, schema] of Object.entries(schemas)) {
const route = `${apiPrefix}/${name.toLowerCase()}`;
const idParam = {
name: 'id',
in: 'path',
required: true,
schema: { type: 'string' }
};
paths[route] = {
get: {
summary: `Get all ${name}`,
tags: [name],
responses: {
200: {
description: `List of ${name}`,
content: {
'application/json': {
schema: {
type: 'array',
items: { $ref: `#/components/schemas/${name}` }
}
}
}
}
}
},
post: {
summary: `Create ${name}`,
tags: [name],
requestBody: {
required: true,
content: {
'application/json': {
schema: { $ref: `#/components/schemas/${name}` }
}
}
},
responses: { 200: { description: 'Created' } }
}
};
paths[`${route}/{id}`] = {
get: {
summary: `Get single ${name}`,
tags: [name],
parameters: [idParam],
responses: {
200: {
description: `${name} found`,
content: {
'application/json': {
schema: { $ref: `#/components/schemas/${name}` }
}
}
},
404: { description: 'Not found' }
}
},
put: {
summary: `Update ${name}`,
tags: [name],
parameters: [idParam],
requestBody: {
required: true,
content: {
'application/json': {
schema: { $ref: `#/components/schemas/${name}` }
}
}
},
responses: { 200: { description: 'Updated' } }
},
delete: {
summary: `Delete ${name}`,
tags: [name],
parameters: [idParam],
responses: { 204: { description: 'Deleted' } }
}
};
const props = Object.entries(schema.properties).reduce((acc, [key, val]) => {
acc[key] = { type: val.type || 'string' };
return acc;
}, {});
componentsSchemas[name] = {
type: 'object',
properties: props,
required: schema.required || []
};
}
return {
openapi: '3.0.0',
info: {
title: 'fastly-auto API',
version: '1.0.0'
},
paths,
components: { schemas: componentsSchemas }
};
}
exports.generateSwaggerSpecFromSchemas = generateSwaggerSpecFromSchemas;