Any plans to support OpenSpec 3.0?

[bengro]

We're migrating from 2.0 to 3.0 and we really like this plugin. Are there any plans to support OpenApi Specification 3.0?

[devdigital]

Hi, thanks, that's been a plan for a while now, but currently struggling for time, so I would imagine it would be a couple of months away at least unfortunately.

[jhodges10]

+1 on support for OAS 3.0!

[jhodges10]

Figured out a solution for the meantime @bengro!

npm install -g api-spec-converter

Then in your package.json, add this task:

"transform-docs": "api-spec-converter --from=openapi_3 --to=swagger_2 --syntax=json --order=alpha [Your OAS spec URL] > ./src/data/swagger.json"

Then also add this before your dev / build phases:

    "dev": "yarn transform-docs && gatsby develop",
    "build": "yarn transform-docs && gatsby build",

[bengro]

Nice one, @jhodges10 👍 !

I wrote my own gatsby plugin because we rely on OpenApi Spec 3.0 features (hence transforming to OpenApi Spec 2.0 wasn't an option). Unfortunately I cannot share the code as it's closed source, but here the gist for peeps in a similar situation.

The hardest part was building the GraphQL model correctly, which is shown here:

import { parseOpenApi3 } from "./api-parser/openapi3parser"
import { ApiOperation } from "./api-parser/types/ApiOperation"

export interface Options {
  specs: string[]
}

exports.sourceNodes = async ({ actions }: any, options: Options) => {
  const allOperations: ApiOperation[] = []

  for (let spec of options.specs) {
    const operations = await parseOpenApi3(spec)

    for (let operation of operations) {
      allOperations.push(operation)
    }
  }

  allOperations.forEach((operation: ApiOperation) => {
    actions.createNode({
      id: operation.path, // assigning a unique id through helper function
      children: [], // no children at this point
      parent: undefined, // no parent
      internal: {
        type: "ApiOperation", // A globally unique name for this node type
        contentDigest: toHashCode(JSON.stringify(operation)),
      },
      ...operation,
    })
  })
}

const toHashCode = (input: string): string => {
  let h: number = 0

  for (let i = 0; i < input.length; i++) {
    h = (Math.imul(31, h) + input.charCodeAt(i)) | 0
  }

  return h.toString()
}

The parsing of the spec is delegating to @apidevtools/swagger-parser.