Programatic usage of the package

[renke0]

I am auto-generating an openapi spec from my code, and I want to use this package to format the final document. Is there a way to import it and use the functions programatically, without having to resort to the CLI?

[thim81]

hi @renke0

Yes, you can use a large part of the package functions in a NodeJS project.

We are using them in the openapi-format-playground, which is a Typescript project.
Example: https://github.com/thim81/openapi-format-playground/blob/main/src/pages/api/format.ts

TypeScript Types: https://github.com/thim81/openapi-format-playground/blob/main/types/openapi-format.d.ts

[renke0]

Yes, dropping it in the root directory of the package should do it. You'll also need to point to the type file in your package json, as well as add it to the files array:

package.json

{
 "name": "openapi-format",
 "type": "openapi-format.d.ts",
 // remaining package json configs
 "files": [
   // current files already exported by the package
   "openapi-format.d.ts"
 ]
}

[thim81]

@renke0 I created a PR, could you check it? I'm no expert in Typescript.

[thim81]

@renke0

Can you manually put the d.ts file in your project and see if it works as expected?

[renke0]

Thanks for the PR, it looks good.

I tested locally, everything seems to be correct.

[thim81]

hi @renke0

We just released openapi-format v1.24, which includes the types.

If you have more requests/needs, let me know.