Swagger Specs Never Read

[jellydn]

Swagger Specs Never Read

[jellydn]

Hi @jersmart Did you try the example apps on this repo yet?

[jersmart]

Hi @jersmart Did you try the example apps on this repo yet?

The example apps worked for me. The biggest difference between the example apps and what's generated by create-next-app is nesting pages etc into the 'src' directory. However, when I try to change

apiFolder: 'pages/api' -> 'src/pages/api'

I get the following error:

- error Error: EISDIR: illegal operation on a directory, read at Object.readSync (node:fs:760:3) at tryReadSync (node:fs:440:20) at Object.readFileSync (node:fs:486:19) at extractAnnotations (/home/example/node_modules/.pnpm/[email protected][email protected]/node_modules/swagger-jsdoc/src/utils.js:54:26) at build (/home/example/node_modules/.pnpm/[email protected][email protected]/node_modules/swagger-jsdoc/src/specification.js:200:9) at Object.module.exports [as default] (/home/example/node_modules/.pnpm/[email protected][email protected]/node_modules/swagger-jsdoc/src/lib.js:32:10) at createSwaggerSpec (/home/example/node_modules/.pnpm/[email protected][email protected][email protected]/node_modules/next-swagger-doc/dist/swagger-99304a1e.cjs:61:48) at getApiDocs (webpack-internal:///./src/swagger.ts:9:85) at getServerSideProps (webpack-internal:///./src/pages/api-doc/index.tsx:30:76) at fn (/home/example/node_modules/.pnpm/[email protected]_patch_hash=tpbd5rbdpqoageh5z5zdjldhkq_@[email protected][email protected][email protected]/node_modules/next/src/server/render.tsx:1028:11) at /home/example/node_modules/.pnpm/[email protected]_patch_hash=tpbd5rbdpqoageh5z5zdjldhkq_@[email protected][email protected][email protected]/node_modules/next/src/server/lib/trace/tracer.ts:261:28 at NoopContextManager.with (/home/example/node_modules/.pnpm/[email protected]_patch_hash=tpbd5rbdpqoageh5z5zdjldhkq_@[email protected][email protected][email protected]/node_modules/next/dist/compiled/@opentelemetry/api/index.js:1:7057) at ContextAPI.with (/home/example/node_modules/.pnpm/[email protected]_patch_hash=tpbd5rbdpqoageh5z5zdjldhkq_@[email protected][email protected][email protected]/node_modules/next/dist/compiled/@opentelemetry/api/index.js:1:516) at NoopTracer.startActiveSpan (/home/example/node_modules/.pnpm/[email protected]_patch_hash=tpbd5rbdpqoageh5z5zdjldhkq_@[email protected][email protected][email protected]/node_modules/next/dist/compiled/@opentelemetry/api/index.js:1:18086) at ProxyTracer.startActiveSpan (/home/example/node_modules/.pnpm/[email protected]_patch_hash=tpbd5rbdpqoageh5z5zdjldhkq_@[email protected][email protected][email protected]/node_modules/next/dist/compiled/@opentelemetry/api/index.js:1:18847) at /home/example/node_modules/.pnpm/[email protected]_patch_hash=tpbd5rbdpqoageh5z5zdjldhkq_@[email protected][email protected][email protected]/node_modules/next/src/server/lib/trace/tracer.ts:238:32 at NoopContextManager.with (/home/example/node_modules/.pnpm/[email protected]_patch_hash=tpbd5rbdpqoageh5z5zdjldhkq_@[email protected][email protected][email protected]/node_modules/next/dist/compiled/@opentelemetry/api/index.js:1:7057) at ContextAPI.with (/home/example/node_modules/.pnpm/[email protected]_patch_hash=tpbd5rbdpqoageh5z5zdjldhkq_@[email protected][email protected][email protected]/node_modules/next/dist/compiled/@opentelemetry/api/index.js:1:516) at NextTracerImpl.trace (/home/example/node_modules/.pnpm/[email protected]_patch_hash=tpbd5rbdpqoageh5z5zdjldhkq_@[email protected][email protected][email protected]/node_modules/next/src/server/lib/trace/tracer.ts:237:28) at renderToHTMLImpl (/home/example/node_modules/.pnpm/[email protected]_patch_hash=tpbd5rbdpqoageh5z5zdjldhkq_@[email protected][email protected][email protected]/node_modules/next/src/server/render.tsx:1019:32) at async doRender (/home/example/node_modules/.pnpm/[email protected]_patch_hash=tpbd5rbdpqoageh5z5zdjldhkq_@[email protected][email protected][email protected]/node_modules/next/src/server/base-server.ts:1802:18) at async cacheEntry.responseCache.get.incrementalCache.incrementalCache (/home/example/node_modules/.pnpm/[email protected]_patch_hash=tpbd5rbdpqoageh5z5zdjldhkq_@[email protected][email protected][email protected]/node_modules/next/src/server/base-server.ts:2031:24) at async /home/example/node_modules/.pnpm/[email protected]_patch_hash=tpbd5rbdpqoageh5z5zdjldhkq_@[email protected][email protected][email protected]/node_modules/next/src/server/response-cache/index.ts:126:28 { digest: undefined }

[jersmart]

Hi @jersmart Did you try the example apps on this repo yet?

The example apps worked for me. The biggest difference between the example apps and what's generated by create-next-app is nesting pages etc into the 'src' directory. However, when I try to change

apiFolder: 'pages/api' -> 'src/pages/api'

I get the following error:

- error Error: EISDIR: illegal operation on a directory, read at Object.readSync (node:fs:760:3) at tryReadSync (node:fs:440:20) at Object.readFileSync (node:fs:486:19) at extractAnnotations (/home/example/node_modules/.pnpm/[email protected][email protected]/node_modules/swagger-jsdoc/src/utils.js:54:26) at build (/home/example/node_modules/.pnpm/[email protected][email protected]/node_modules/swagger-jsdoc/src/specification.js:200:9) at Object.module.exports [as default] (/home/example/node_modules/.pnpm/[email protected][email protected]/node_modules/swagger-jsdoc/src/lib.js:32:10) at createSwaggerSpec (/home/example/node_modules/.pnpm/[email protected][email protected][email protected]/node_modules/next-swagger-doc/dist/swagger-99304a1e.cjs:61:48) at getApiDocs (webpack-internal:///./src/swagger.ts:9:85) at getServerSideProps (webpack-internal:///./src/pages/api-doc/index.tsx:30:76) at fn (/home/example/node_modules/.pnpm/[email protected]_patch_hash=tpbd5rbdpqoageh5z5zdjldhkq_@[email protected][email protected][email protected]/node_modules/next/src/server/render.tsx:1028:11) at /home/example/node_modules/.pnpm/[email protected]_patch_hash=tpbd5rbdpqoageh5z5zdjldhkq_@[email protected][email protected][email protected]/node_modules/next/src/server/lib/trace/tracer.ts:261:28 at NoopContextManager.with (/home/example/node_modules/.pnpm/[email protected]_patch_hash=tpbd5rbdpqoageh5z5zdjldhkq_@[email protected][email protected][email protected]/node_modules/next/dist/compiled/@opentelemetry/api/index.js:1:7057) at ContextAPI.with (/home/example/node_modules/.pnpm/[email protected]_patch_hash=tpbd5rbdpqoageh5z5zdjldhkq_@[email protected][email protected][email protected]/node_modules/next/dist/compiled/@opentelemetry/api/index.js:1:516) at NoopTracer.startActiveSpan (/home/example/node_modules/.pnpm/[email protected]_patch_hash=tpbd5rbdpqoageh5z5zdjldhkq_@[email protected][email protected][email protected]/node_modules/next/dist/compiled/@opentelemetry/api/index.js:1:18086) at ProxyTracer.startActiveSpan (/home/example/node_modules/.pnpm/[email protected]_patch_hash=tpbd5rbdpqoageh5z5zdjldhkq_@[email protected][email protected][email protected]/node_modules/next/dist/compiled/@opentelemetry/api/index.js:1:18847) at /home/example/node_modules/.pnpm/[email protected]_patch_hash=tpbd5rbdpqoageh5z5zdjldhkq_@[email protected][email protected][email protected]/node_modules/next/src/server/lib/trace/tracer.ts:238:32 at NoopContextManager.with (/home/example/node_modules/.pnpm/[email protected]_patch_hash=tpbd5rbdpqoageh5z5zdjldhkq_@[email protected][email protected][email protected]/node_modules/next/dist/compiled/@opentelemetry/api/index.js:1:7057) at ContextAPI.with (/home/example/node_modules/.pnpm/[email protected]_patch_hash=tpbd5rbdpqoageh5z5zdjldhkq_@[email protected][email protected][email protected]/node_modules/next/dist/compiled/@opentelemetry/api/index.js:1:516) at NextTracerImpl.trace (/home/example/node_modules/.pnpm/[email protected]_patch_hash=tpbd5rbdpqoageh5z5zdjldhkq_@[email protected][email protected][email protected]/node_modules/next/src/server/lib/trace/tracer.ts:237:28) at renderToHTMLImpl (/home/example/node_modules/.pnpm/[email protected]_patch_hash=tpbd5rbdpqoageh5z5zdjldhkq_@[email protected][email protected][email protected]/node_modules/next/src/server/render.tsx:1019:32) at async doRender (/home/example/node_modules/.pnpm/[email protected]_patch_hash=tpbd5rbdpqoageh5z5zdjldhkq_@[email protected][email protected][email protected]/node_modules/next/src/server/base-server.ts:1802:18) at async cacheEntry.responseCache.get.incrementalCache.incrementalCache (/home/example/node_modules/.pnpm/[email protected]_patch_hash=tpbd5rbdpqoageh5z5zdjldhkq_@[email protected][email protected][email protected]/node_modules/next/src/server/base-server.ts:2031:24) at async /home/example/node_modules/.pnpm/[email protected]_patch_hash=tpbd5rbdpqoageh5z5zdjldhkq_@[email protected][email protected][email protected]/node_modules/next/src/server/response-cache/index.ts:126:28 { digest: undefined }

I found the root cause of this issue. I have directories in the api folder that have a period in them that simulate retrieval of a file but actually build them dynamically (fwiw, not my design decision.) The error is accurate; it's trying to read a directory like its a file because it looks like one. This error is reproducible in the example:

1. move the 'hello.ts' api endpoint into a folder called 'test.json'

[jersmart]

This appears to be due to a bug in the swagger-jsdoc repo: Surnet/swagger-jsdoc#388