iframe-proxy | Sunbelt Computer Software

193 lines (189 loc) · 5.02 KB
 * Example for openapi v3
 * - using parameters in path to service
 * - using custom methods introduced with @feathersjs/express v4
 *   - with security
 *   - with refs for request and response
const { activateHooks } = require('@feathersjs/feathers');
const { httpMethod } = require('@feathersjs/express/rest');
const swagger = require('../../lib');
const contentSchema = (schema) => ({
  content: {
    'application/json': {
      schema
module.exports = (app) => {
  const service = {
    find (params) {
      return Promise.resolve({ method: 'find', params });
    customPost: httpMethod('POST', '/do-post')(activateHooks(['params', 'data'])((data, params) => {
      return Promise.resolve({ method: 'customPost', data, params });
    customPatchWithId: httpMethod('PUT', '/do-patch-with/:__feathersId')(activateHooks(['id', 'params', 'data'])(
      (id, data, params) => {
        return Promise.resolve({ method: 'customPatchWithId', id, data, params });
    customGetWithCustomIds: httpMethod('GET', '/do-patch-with/:customId/:customId2')(activateHooks(['params', 'data'])(
      (data, params) => {
        return Promise.resolve({ method: 'customGetWithCustomIds', data, params });
  service.docs = {
    description: 'A service with custom methods',
    pathParams: {
      pathParamName: {
        description: 'A global path param',
        in: 'path',
        name: 'pathParamName',
        schema: {
          type: 'string'
        required: true
    tag: 'custom method service',
    definitions: {
      custom_response: {
        title: 'Custom service response',
        type: 'object',
        required: [
          'method'
        properties: {
          method: {
            type: 'string',
            description: 'name of the called method'
          data: {
            type: 'object',
            description: 'POST data provided to the service method'
          params: {
            type: 'object',
            description: 'params provided to the service method'
          id: {
            type: 'integer',
            description: 'id provided to the service method'
      custom_request: {
        title: 'Custom service requestBody',
        type: 'object',
        required: [
          'method'
        properties: {
          string: {
            type: 'string',
            description: 'some string data'
          number: {
            type: 'number',
            format: 'int32',
            description: 'a number'
    securities: ['customPost'],
    refs: {
      customPostRequest: 'custom_request',
      customPostResponse: 'custom_response',
      customPatchWithIdRequest: 'custom_request',
      customPatchWithIdResponse: 'custom_response'
    operations: {
      find: {
        description: 'Do something with a GET method',
        // remove default parameters with nested path 'logic'
        'parameters[3]': undefined,
        'parameters[2]': undefined,
        'parameters[1]': {
          description: 'A defined param',
          in: 'query',
          name: 'test',
          schema: {
            type: 'string'
        'responses.200': {
          description: 'Use find to do a normal GET',
          ...contentSchema({ $ref: `#/components/schemas/custom_response` })
      customPost: {
        description: 'A custom POST method',
        'parameters[]': {
          description: 'A defined param',
          in: 'query',
          name: 'test',
          schema: {
            type: 'string'
      customGetWithCustomIds: {
        description: 'A custom GET method',
        'parameters[1]': {
          description: 'Custom integer path id',
          in: 'path',
          required: true,
          name: 'customId',
          schema: {
            type: 'integer'
        'parameters[2]': {
          description: 'Custom string path id',
          in: 'path',
          required: true,
          name: 'customId2',
          schema: {
            type: 'string'
  app.configure(swagger({
    openApiVersion: 3,
    docsPath: '/v3/custom-methods',
    prefix: 'v3/custom-methods/',
    docsJsonPath: '/v3/custom-methods.json',
    uiIndex: true,
    specs: {
      info: {
        title: 'A test',
        description: 'An example using custom methods of @feathersjs/express v4',
        version: '1.0.0'
      components: {
        securitySchemes: {
          BasicAuth: {
            type: 'http',
            scheme: 'basic'
          BearerAuth: {
            type: 'http',
            scheme: 'bearer'
      security: [
        { BearerAuth: [] }
    include: {
      paths: ['v3/custom-methods/:pathParamName/service']
    .use('/v3/custom-methods/:pathParamName/service', service);
Sunbelt Computer Software

PL/B Language Development and Support

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Sunbelt Computer Software

PL/B Language Development and Support

Uh oh!

FilesExpand file tree

customMethods.js

Latest commit

History

customMethods.js

File metadata and controls
