
Security News
Oracle Drags Its Feet in the JavaScript Trademark Dispute
Oracle seeks to dismiss fraud claims in the JavaScript trademark dispute, delaying the case and avoiding questions about its right to the name.
moleculer-auto-openapi
Advanced tools
Auto generate openapi(swagger) scheme for molecular. Scheme generated based on action validation params, routes on all avalaibled services and paths in ApiGateway.
npm i moleculer-auto-openapi --save
Create openapi.service.js with content:
const Openapi = require("moleculer-auto-openapi");
module.exports = {
name: 'openapi',
mixins: [Openapi],
settings: {
// all setting optional
openapi: {
info: {
// about project
description: "Foo",
title: "Bar",
},
tags: [
// you tags
{ name: "auth", description: "My custom name" },
],
components: {
// you auth
securitySchemes: {
myBasicAuth: {
type: 'http',
scheme: 'basic',
},
},
},
},
},
}
And add resolvers to your webapi service:
module.exports = {
name: `api`,
mixins: [ApiGateway],
settings: {
routes: [
// moleculer-auto-openapi routes
{
path: '/api/openapi',
aliases: {
'GET /openapi.json': 'openapi.generateDocs', // swagger scheme
'GET /ui': 'openapi.ui', // ui
'GET /assets/:file': 'openapi.assets', // js/css files
},
},
],
},
};
Describe params in service:
module.exports = {
actions: {
update: {
openapi: {
summary: "Foo bar baz",
},
params: {
$$strict: "remove",
roles: { type: "array", items: "string", enum: [ "user", "admin" ] },
sex: { type: "enum", values: ["male", "female"], default: "female" },
id: { type: "number", convert: true, default: 5 },
numberBy: "number",
someNum: { $$t: "Is some num", type: "number", convert: true },
types: {
type: "array",
$$t: "Types arr",
default: [{ id: 1, typeId: 5 }],
length: 1,
items: {
type: "object", strict: "remove", props: {
id: { type: "number", optional: true },
typeId: { type: "number", optional: true },
},
},
},
bars: {
type: "array",
$$t: "Bars arr",
min: 1,
max: 2,
items: {
type: "object", strict: "remove", props: {
id: { type: "number", optional: true },
fooNum: { $$t: "fooNum", type: "number", optional: true },
},
},
},
someObj: {
$$t: "Some obj",
default: { name: "bar" },
type: "object", strict: "remove", props: {
id: { $$t: "Some obj ID", type: "number", optional: true },
numberId: { type: "number", optional: true },
name: { type: "string", optional: true, max: 100 },
},
},
someBool: { type: "boolean", optional: true },
desc: { type: "string", optional: true, max: 10, min: 4, },
email: "email",
date: "date|optional|min:0|max:99",
uuid: "uuid",
url: "url",
shortObject: {
$$type: "object",
desc: { type: "string", optional: true, max: 10000 },
url: "url",
},
shortObject2: {
$$type: "object|optional",
desc: { type: "string", optional: true, max: 10000 },
url: "url",
},
password: { type: 'string', min: 8, pattern: /^[a-zA-Z0-9]+$/ },
password2: { type: 'string', min: 8, pattern: '^[a-zA-Z0-9]+$' }
},
handler() {},
},
},
}
end etc. See test/openapi.mixin.spec.js for examples
FAQs
Auto generate openapi(swagger) scheme for molecular
We found that moleculer-auto-openapi demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Oracle seeks to dismiss fraud claims in the JavaScript trademark dispute, delaying the case and avoiding questions about its right to the name.
Security News
The Linux Foundation is warning open source developers that compliance with global sanctions is mandatory, highlighting legal risks and restrictions on contributions.
Security News
Maven Central now validates Sigstore signatures, making it easier for developers to verify the provenance of Java packages.