How do I generate openapi spec?

[freez10]

Hi there.

As for now, in order to generate open api spec I have start the application.

Eg I have the following configuration '

@Configuration({
  ...
  swagger: {
    outFile: process.env.NODE_ENV !== 'production' ? `${ rootDir }/openapi/public.json` : undefined,
  }
})

I have to start the app eg with yarn start in order to get the spec

The question is how do I generate the spec without having app fully up and running, listening on port etc.
Eg with yarn generate:spec having this script exited right after generation completes

The thing is that during the build process eg on CI\CD stage I need to also generate and publish API clients for other back-end and front-end services using the spec, so it would be great having possibility to generate the spec during build, instead of having to start app eg on dev env to get updated spec, then commit and push it so that clients could be generated by the actual spec.

Hope you got what I mean )

[Romakita]

Hello @freez10
On my project I use the CLI to generate the front-end code from the swagger spec.

https://github.com/tsedio/tsed-cli/tree/master/packages/cli-generate-http-client

You need to have the a custom command on your project level and implement the command class as following:

https://github.com/tsedio/tsed-cli/blob/master/packages/cli-generate-http-client/src/commands/GenerateHttpClientCmd.ts

But instead generating client code, you just need to have to write the swagger.json here:

https://github.com/tsedio/tsed-cli/blob/master/packages/cli-generate-http-client/src/commands/GenerateHttpClientCmd.ts#L106

See you
Romain

[AlexW00]

The @tsed/cli-generate-swagger is on npm :D

The swagger.json file gets generated fine. However, there seems to be an issue with the yaml version:

λ › npm run build:specs                                          Work/tsed-api master

> [email protected] build:specs
> tsed run generate-swagger --output out

[18:13:07] ✔ @tsed/cli-plugin-eslint module loaded
✖ ENOENT: no such file or directory, open '/home/aw/Developer/Work/tsed-api/home/aw…
[Error: ENOENT: no such file or directory, open '/home/aw/Developer/Work/tsed-api/home/aw/Developer/Work/tsed-api/out/doc/swagger.yaml'] {
  name: 'CLI_ERROR',
  cli: CliCore { injector: [Getter], cliService: [Getter] },
  origin: [Error: ENOENT: no such file or directory, open '/home/aw/Developer/Work/tsed-api/home/aw/Developer/Work/tsed-api/out/doc/swagger.yaml'] {
    errno: -2,
    code: 'ENOENT',
    syscall: 'open',
    path: '/home/aw/Developer/Work/tsed-api/home/aw/Developer/Work/tsed-api/out/doc/swagger.yaml'
  }
}

[Romakita]

Yes I saw that. it's fixed with v4.4.1 ;)

[AlexW00]

Btw, cli-generate-http-client depends on an old version (9.3.1) of swagger-typescript-api. When installing the package via NPM, 3 high vulnerabilities pop up. This could be fixed by bumping the version of swagger-typescript-api up (e.g. to the latest one which is 12.0.3)

[Romakita]

Yep. You can make PR.
Otherwise I’ll do that tomorrow ;)

[AlexW00]

Yep. You can make PR. Otherwise I’ll do that tomorrow ;)

Tried to create a PR following the contribution guide, but the test pipeline failed :/