codegen won't even fetch openapi.json and throws a syntax error

[phretor]

@rtk-query/codegen-openapi have suddently stopped working: it worked fine so far with this setup. It doesn't even bother to fetch the openapi.json file from the URL and throws this error:

> frontend@0.1.0 apigen
> npx @rtk-query/codegen-openapi openapi-config.ts

{
  stack: 'SyntaxError: "/Users/user/Projects/frontend/openapi-config.ts" is not a valid JSON Schema\n' +
    '    at SwaggerParser.parse (/Users/user/Projects/frontend/node_modules/@apidevtools/json-schema-ref-parser/lib/index.js:131:17)\n' +
    '    at async SwaggerParser.parse (/Users/user/Projects/frontend/node_modules/@apidevtools/swagger-parser/lib/index.js:60:18)\n' +
    '    at async SwaggerParser.resolve (/Users/user/Projects/frontend/node_modules/@apidevtools/json-schema-ref-parser/lib/index.js:184:5)\n' +
    '    at async SwaggerParser.bundle (/Users/user/Projects/frontend/node_modules/@apidevtools/json-schema-ref-parser/lib/index.js:227:5)\n' +
    '    at async Object.getV3Doc (/Users/user/Projects/frontend/node_modules/@rtk-incubator/rtk-query-codegen-openapi/lib/utils/getV3Doc.js:11:17)\n' +
    '    at async Object.generateApi (/Users/user/Projects/frontend/node_modules/@rtk-incubator/rtk-query-codegen-openapi/lib/generate.js:41:19)',
  message: '"/Users/user/Projects/frontend/openapi-config.ts" is not a valid JSON Schema',
  toJSON: [Function: toJSON],
  name: 'SyntaxError',
  toString: [Function: toString]
}

The openapi-config.ts is:

import { ConfigFile } from '@rtk-query/codegen-openapi'

const config: ConfigFile = {
    schemaFile: 'http://127.0.0.1:8000/openapi.json',
    apiFile: './src/fixtures/emptyApi.ts',
    apiImport: 'emptySplitApi',
    outputFile: './src/service/scannerApi.ts',
    exportName: 'scannerApi',
    hooks: true,
}

export default config

And here's the emptyApi.ts:

import { createApi, fetchBaseQuery } from '@reduxjs/toolkit/query/react'

const API_URL = (
  process.env.REACT_APP_API_URL ?
    process.env.REACT_APP_API_URL : "http://127.0.0.1:8000")

const emptySplitApi = createApi({
  baseQuery: fetchBaseQuery({
    baseUrl: API_URL
  }),
  endpoints: () => ({}),
})

export {
  API_URL,
  emptySplitApi
}

[phryneas]

From the stack trace, you are invoking @rtk-incubator/rtk-query-codegen-openapi here, not @rtk-query/codegen-openapi - and that takes a schema as command line argument, not the config file. Do you have the package names mapped weirldy somehow?

[phretor]

Thank you @phryneas - I'd have never caught that.

[alaamh]

since the library @rtk-incubator/rtk-query-codegen-openapi moved permanently to @rtk-query/codegen-openapi, this solution is not workable.

[phryneas]

I don't really know what you want to tell us with that. What are you trying? What is your problem?

[alaamh]

I'm getting the same error SyntaxError: openapi-config.ts is not a valid JSON Schema, and as suggested I have tried to invoke @rtk-incubator/rtk-query-codegen-openapi which gives another error that it is not found because it has been moved permanently to @rtk-query/codegen-openapi

openapi-config.json:

{
    "schemaFile": "./openapi.json",
    "apiFile": "./src/store/emptyApi.ts",
    "apiImport": "emptySplitApi",
    "outputFile": "./src/store/petApi.ts",
    "exportName": "petApi",
    "hooks": true
}

and

npx @rtk-incubator/rtk-query-codegen-openapi openapi-config.json

error:

{
  stack: 'SyntaxError: /openapi-config.json is not a valid Openapi API definition\n' +
    '    at SwaggerParser.parse (/node_modules/@apidevtools/swagger-parser/lib/index.js:84:19)\n' +
    '    at async SwaggerParser.resolve (/node_modules/@apidevtools/json-schema-ref-parser/lib/index.js:184:5)\n' +
    '    at async SwaggerParser.bundle (/node_modules/@apidevtools/json-schema-ref-parser/lib/index.js:227:5)\n' +
    '    at async Object.getV3Doc (/node_modules/@rtk-incubator/rtk-query-codegen-openapi/lib/utils/getV3Doc.js:11:17)\n' +
    '    at async Object.generateApi (/node_modules/@rtk-incubator/rtk-query-codegen-openapi/lib/generate.js:41:19)',
  message: '/openapi-config.json is not a valid Openapi API definition',
  toJSON: [Function: toJSON],
  name: 'SyntaxError',
  toString: [Function: toString]
}

[alaamh]

However, I have followed the original example in https://redux-toolkit.js.org/rtk-query/usage/code-generation

import type { ConfigFile } from '@rtk-query/codegen-openapi'

const config: ConfigFile = {
  schemaFile: 'https://petstore3.swagger.io/api/v3/openapi.json',
  apiFile: './src/store/emptyApi.ts',
  apiImport: 'emptySplitApi',
  outputFile: './src/store/petApi.ts',
  exportName: 'petApi',
  hooks: true,
}

export default config

and then call the code generator:

npx @rtk-query/codegen-openapi openapi-config.ts

but getting the same error:

{
  stack: 'SyntaxError: /openapi-config.json is not a valid Openapi API definition\n' +
    '    at SwaggerParser.parse (/node_modules/@apidevtools/swagger-parser/lib/index.js:84:19)\n' +
    '    at async SwaggerParser.resolve (/node_modules/@apidevtools/json-schema-ref-parser/lib/index.js:184:5)\n' +
    '    at async SwaggerParser.bundle (/node_modules/@apidevtools/json-schema-ref-parser/lib/index.js:227:5)\n' +
    '    at async Object.getV3Doc (/node_modules/@rtk-incubator/rtk-query-codegen-openapi/lib/utils/getV3Doc.js:11:17)\n' +
    '    at async Object.generateApi (/node_modules/@rtk-incubator/rtk-query-codegen-openapi/lib/generate.js:41:19)',
  message: '/openapi-config.json is not a valid Openapi API definition',
  toJSON: [Function: toJSON],
  name: 'SyntaxError',
  toString: [Function: toString]
}

[phryneas]

For some reason you are getting an error message referencing @rtk-incubator/rtk-query-codegen-openapi, which is not referenced by @rtk-query/codegen-openapi in any way.

Tbh., I cannot imagine that this error can actually occur like that by calling npx @rtk-query/codegen-openapi in any way, but maybe you have some weird local cache or node_modules?

[alaamh]

you were right, as you suggested I have cleared the node cache and it is working as expected.