Programmatic usage

[vladshcherbin]

hey, is there a way to format openapi json from nodejs itself?

To be able to use this way:

const formattedJson = format(openapiJson)

[thim81]

Hi @vladshcherbin

That is possible. OpenAPI-format exports all the needed functions to be used.

import {
  detectFormat, OpenAPICasingOptions, OpenAPICasingSet, openapiChangeCase,
  openapiFilter,
  OpenAPIFilterOptions,
  OpenAPIFilterSet,
  openapiGenerate, OpenAPIGenerateOptions, OpenAPIGenerateSet, openapiOverlay, OpenAPIOverlayOptions,
  OpenAPIResult,
  openapiSort,
  OpenAPISortOptions,
  OpenAPISortSet,
  parseString,
  stringify
} from 'openapi-format';

[thim81]

We use the library in a such a way in the https://openapi-format-playground.vercel.app/

[vladshcherbin]

@thim81 can you please help me understand how to use it?

I just wanna sort with default options as in CLI. Using it like this:

// options are taken from https://github.com/thim81/openapi-format-playground/blob/main/src/defaults/defaultSort.json
const defaultOptions = { ... }

await openapiSort(openApiJson, { sortSet: defaultOptions })

results in ReferenceError: __dirname is not defined

[vladshcherbin]

From source code I figured out __dirname is used in here too:
https://github.com/thim81/openapi-format/blob/v1.28.0/openapi-format.js#L61

So with both options it works:

await openapiSort(openApiJson, { sortComponentsSet: [], sortSet: defaultOptions })

Is it possible to export this default options or make them optional so that I don't need to copy-paste them? Seems like sortSet is mandatory to set

[thim81]

hi @vladshcherbin

Based on your valid feedback and input, we improved the module usage of openapi-format.
We created a #186 to handle the default sort sets better and sortSet is no longer “mandatory”. openapiSort() now falls back to the defaults automatically.

If you update to openapi-format v1.29.2, you will be able to use these new options.

Thanks for taking the time report your feedback, and help us improve OpenAPI-format 🤝 .

I'll close the issue. In case you run into issues, please report back so we can tackle them.

[vladshcherbin]

thank you!