api calls names

[VitaliKhileuski]

How can i customize name generating of api calls? For this moment i see that name generate from route parts and word Create that is not comfortable for me

[TimAlaerts]

@VitaliKhileuski in case you are still wondering you can specify the name in swagger via the "operationId" property and the generator will use that name instead

[js2me]

Hello @VitaliKhileuski !
You can use hooks api \ templates (route-name) for customizing name generating of api calls

In my case I use hooks api

Where generateOperationId is

const ACTION_METHODS = ["post", "put", "patch"]

const generateOperationId = (routeInfo) => {
  const {
    method,
    route,
    moduleName,
    pathArgs,
  } = routeInfo;

  const usageRoutePart = _.split(route, moduleName)[1] || _.split(route, _.kebabCase(moduleName))[1]
  const parts = _.split(route, "/");
  const lastPart = _.last(parts);

  const firstPathArg = pathArgs[0]

  if (!usageRoutePart) {
    return _.camelCase(`${method}_${moduleName}`)
  }

  return _.camelCase(_.compact([
    ACTION_METHODS.includes(method) ? "" : method,
    lastPart,
    ...(firstPathArg && firstPathArg.name !== lastPart ? [
      'by',
      firstPathArg.name
    ] : []),
  ]).join('_'))
};

[js2me]

Otherwise you are able to change operation id with using templates
https://github.com/acacode/swagger-typescript-api/blob/master/templates/base/route-name.eta

Also FYI - return value from route-name.eta template is a second argument for onFormatRouteName hook called templateRouteName

[VitaliKhileuski]

@js2me Thanks, I used operation id as names

[Leningram]

Where should I put the config with hooks? In what file and what folder? I just have swagger.json in my root folder of react app and then just run npx swagger-typescript-api ...etc

[js2me]

@Leningram Hi!

You can put config with hooks where you want!

I put config at the root of project, near with src, types folder inside the swagger-api-codegen directory

And use this scripts from package.json

And thats my config

require('dotenv').config();
const { generateApi } = require("swagger-typescript-api");
const path = require('path');
const generateOperationId = require("./generateOperationId");

generateApi({
  url: process.env.SWAGGER_SCHEMA,
  output: path.resolve(__dirname, '../src/shared/api/__generated__'),
  templates: path.resolve(__dirname, './templates'),
  httpClientType: "axios",
  cleanOutput: true,
  modular: true,
  singleHttpClient: true,
  moduleNameIndex: 2,
  extractRequestBody: true,
  extractRequestParams: true,
  extractResponseBody: true,
  extractResponseError: true,
  generateResponses: true,
  sortTypes: true,
  hooks: {
    onFormatRouteName: (routeInfo, templateRouteName) => {
      if (!routeInfo.operationId) {
        return generateOperationId(routeInfo);
      }

      return templateRouteName;
    },
    onPrepareConfig: (configuration) => {
      // configuration.routes.combined = configuration.routes.combined.filter(route => route.moduleName !== "ws")
    }
  }
})