1import { OpenApiMixin, type OpenApiMixinSettings, type MoleculerWebTypes } from '@spailybot/moleculer-auto-openapi';
2import { Service, type ServiceBroker } from 'moleculer';
3
4/**
5 * MoleculerWebTypes are typings created from moleculer-web to enhance included typings; their use is totally optional.
6 */
7
8export default class OpenApiService extends Service<OpenApiMixinSettings & MoleculerWebTypes.RestServiceSettings> {
9    public constructor(public broker: ServiceBroker) {
10        super(broker);
11
12        this.parseServiceSchema({
13            // Choose your preferred name
14            name: 'openapi',
15            mixins: [mixin],
16            settings: {
17                // Set the path as you prefer
18                rest: '/openapi',
19                // Path to the endpoint that returns the JSON
20                // With autoalias, it's exposed on /openapi.json
21                schemaPath: '/openapi/openapi.json',
22                // This will be the root of your document
23                // use it to define some default informations
24                openapi: {
25                    info: {
26                        title: "My API",
27                        version: "0.0.1"
28                    }
29                }
30            }
31        });
32    }
33}

1import { OpenApiMixin, type OpenApiMixinSettings, type MoleculerWebTypes } from '@spailybot/moleculer-auto-openapi';
2import { Service, type ServiceBroker } from 'moleculer';
3
4const OpenApiService: ServiceSchema<OpenApiMixinSettings & MoleculerWebTypes.RestServiceSettings> = {
5    // Choose your preferred name
6    name: 'openapi',
7    mixins: [mixin],
8    settings: {
9        // Set the path as you prefer
10        rest: '/openapi',
11        // Path to the endpoint that returns the JSON
12        // With autoalias, it's exposed on /openapi.json
13        schemaPath: '/openapi/openapi.json',
14        // This will be the root of your document
15        // use it to define some default informations
16        openapi: {
17          info: {
18            title: "My API",
19            version: "0.0.1"
20          }
21        }
22    }
23};
24export default OpenApiService;

1import { OpenApiMixin } from '@spailybot/moleculer-auto-openapi';
2import { Service } from 'moleculer';
3
4export default class OpenApiService extends Service {
5    public constructor(broker) {
6        super(broker);
7
8        this.parseServiceSchema({
9            // Choose your preferred name
10            name: 'openapi',
11            mixins: [OpenApiMixin],
12            settings: {
13                // Set the path as you prefer
14                rest: '/openapi',
15                // Path to the endpoint that returns the JSON
16                // With autoalias, it's exposed on /openapi.json
17                schemaPath: '/openapi/openapi.json',
18                // This will be the root of your document
19                // use it to define some default informations
20                openapi: {
21                    info: {
22                        title: "My API",
23                        version: "0.0.1"
24                    }
25                }
26            }
27        });
28    }
29}

1import { OpenApiMixin } from '@spailybot/moleculer-auto-openapi';
2import { Service } from 'moleculer';
3
4const OpenApiService = {
5  // Choose your preferred name
6  name: 'openapi',
7  mixins: [mixin],
8  settings: {
9    // Set the path as you prefer
10    rest: '/openapi',
11    // Path to the endpoint that returns the JSON
12    // With autoalias, it's exposed on /openapi.json
13    schemaPath: '/openapi/openapi.json',
14    // This will be the root of your document
15    // use it to define some default informations
16    openapi: {
17      info: {
18        title: "My API",
19        version: "0.0.1"
20      }
21    }
22  }
23};
24export default OpenApiService;

1const OpenApiMixin = require('@spailybot/moleculer-auto-openapi');
2// or
3// const { OpenApiMixin } = require('@spailybot/moleculer-auto-openapi');
4import { Service } from 'moleculer';
5
6module.exports = {
7   // Choose your preferred name
8   name: 'openapi',
9   mixins: [mixin],
10   settings: {
11       // Set the path as you prefer
12       rest: '/openapi',
13       // Path to the endpoint that returns the JSON
14       // With autoalias, it's exposed on /openapi.json
15       schemaPath: '/openapi/openapi.json',
16       // This will be the root of your document
17       // use it to define some default informations
18       openapi: {
19         info: {
20           title: "My API",
21           version: "0.0.1"
22         }
23       }
24   }
25};

1import type { ApiSettingsSchemaOpenApi } from '@spailybot/moleculer-auto-openapi';
2import ApiGateway from "moleculer-web";
3import { Service, type ServiceBroker } from 'moleculer';
4
5/**
6 * Note that ApiSettingsSchemaOpenApi is a re-export of ApiSettingsSchema because moleculer-web doesn't allow to extend it.
7 */
8
9export default class WebApiService extends Service<ApiSettingsSchemaOpenApi> {
10    public constructor(public broker: ServiceBroker) {
11        super(broker);
12
13        this.parseServiceSchema({
14            name: "api",
15            mixins: [mixin],
16            settings: {
17                // Place other settings here
18                openapi: {
19                    // Define an OpenAPI specification that will be applied to all routes of this api
20                },
21                routes: [
22                    // Place additional route configurations here
23                    {
24                        openapi: {
25                            // Define an OpenAPI specification that will apply to all aliases within this route
26                        },
27                        path: '/openapi',
28                        aliases: {
29                            'GET /openapi.json': 'openapi.generateDocs',
30                            'GET /ui': 'openapi.ui',
31                            'GET /assets/:file': 'openapi.assets',
32                            'GET /oauth2-redirect': 'openapi.oauth2Redirect',
33                        },
34                    },
35                    // To use autoAliases, refer to the following configuration
36                    // {
37                    //     path: '/openapi',
38                    //     whitelist: ['openapi.*'],
39                    //     autoAliases: true
40                    // }
41
42                ]
43                // Insert other settings here
44            }
45        });
46    }
47}

1import ApiGateway from "moleculer-web";
2import { Service } from 'moleculer';
3
4export default class WebApiService extends Service {
5    public constructor(broker) {
6        super(broker);
7
8        this.parseServiceSchema({
9            name: "api",
10            mixins: [mixin],
11            settings: {
12                // Place other settings here
13                openapi: {
14                    // Define an OpenAPI specification that will be applied to all routes of this api
15                },
16                routes: [
17                    // Place additional route configurations here
18                    {
19                        openapi: {
20                            // Define an OpenAPI specification that will apply to all aliases within this route
21                        },
22                        path: '/openapi',
23                        aliases: {
24                            'GET /openapi.json': 'openapi.generateDocs',
25                            'GET /ui': 'openapi.ui',
26                            'GET /assets/:file': 'openapi.assets',
27                            'GET /oauth2-redirect': 'openapi.oauth2Redirect',
28                        },
29                    },
30                    // To use autoAliases, refer to the following configuration
31                    // {
32                    //     path: '/openapi',
33                    //     whitelist: ['openapi.*'],
34                    //     autoAliases: true
35                    // }
36
37                ]
38                // Insert other settings here
39            }
40        });
41    }
42}