graphql/yoga-server/docs/features/sofa-api

[giscus[bot]]

graphql/yoga-server/docs/features/sofa-api

GraphQL Yoga Documentation

https://the-guild.dev/graphql/yoga-server/docs/features/sofa-api

[bastianhilton]

I get these error messages:

Module '"graphql-yoga"' has no exported member 'createSchema'
Module '"graphql-yoga"' has no exported member 'createYoga'

and in createYoga i get this:

'schema' is declared here

any ideas why this is happening

[saihaj]

are you on the beta version of v3? createYoga only works in v3 and from this error it looks like you are on v2?

[bastianhilton]

I wasn't on v3 thank you

[bastianhilton]

i upgraded to v3 and now the remaining error message is inside of useSofaWithSwaggerUI I get this error message:

Argument of type '{ basePath: string; swaggerUIEndpoint: string; servers: { url: string; description: string; }[]; info: { title: string; version: string; }; }' is not assignable to parameter of type 'SofaWithSwaggerUIPluginConfig'.
Property 'schema' is missing in type '{ basePath: string; swaggerUIEndpoint: string; servers: { url: string; description: string; }[]; info: { title: string; version: string; }; }' but required in type '{ schema: GraphQLSchema; info: InfoObject; servers?: ServerObject[] | undefined; components?: Record<string, any> | undefined; security?: SecurityRequirementObject[] | undefined; tags?: TagObject[] | undefined; customScalars?: Record<...> | undefined; }'.ts(2345)
index.d.ts(5, 5): 'schema' is declared here.

[ardatan]

Could you try installing the plugin package with three tag?
@graphql-yoga/plugin-sofa

[maurerbot]

Also had to use this

seSofaWithSwaggerUI({
      basePath: '/rest',
      swaggerUIEndpoint: '/swagger',
      info: {
        title: 'Galaxy API',
        version: '0.0.1',
      },
    }),

[maurerbot]

How can I get the json schema from the server to be imported to my docs?

[maurerbot]

Found it. Just add .json to the /swagger endpoint

[maurerbot]

How do you get headers attached to all the swagger methods?

[maurerbot]

got it:

useSofaWithSwaggerUI({
    servers: [{ url: 'https://galaxy.rollup.id', description: 'Production' }],
    components: {
      securitySchemes: {
        galaxyApiKey: {
          type: 'apiKey',
          in: 'header',
          name: 'X-GALAXY-API-KEY',
        },
        bearerAuthorization: {
          type: 'http',
          scheme: 'bearer',
          bearerFormat: 'JWT',
          name: 'Authorization',
        },
      },
    },
    basePath: '/rest',
    swaggerUIEndpoint: '/swagger',
    info: {
      title: 'Galaxy API',
      version: '0.0.1',
    },
  }),

[alirezaRaisSattari]

how to add tags to swagger? it have tag key but in document don't explain that.

[Hurled4505]

How would you attach attach a header only to some swagger methdos and not to all (securityScheme)?
Something like using the "parameters" component from Swagger (https://swagger.io/docs/specification/components/) to create a custom header attribute and then later using it for some some routes but not for alll? (as here in this doc https://swagger.io/docs/specification/paths-and-operations/)
As far as I could figure out the only allowed parameters for a route are:

• document
• method
• path
• tags
• description

[devhoangkien]

const yoga = createYoga({
  landingPage: true,
  schema: createSchema({ typeDefs, resolvers }),
  plugins: [
    useSofa({
      basePath: '/api',
      swaggerUI: {
        endpoint: '/swagger'
      },
      openAPI: {
        info: {
          title: 'Bun Server REST API',
          version: '1.0.0',
          description: 'Bun Server REST API'

        }
      },
    })
  ]
},)

I call rest api on swagger successfully. but when calling on graphql, the following error is reported. Haven't called the server yet

{
  "errors": [
    {
      "message": "Failed to fetch",
      "extensions": {
        "requestBody": {
          "query": "query MyQuery {\n  getPost(id: 1) {\n    content\n    title\n    id\n  }\n}",
          "operationName": "MyQuery"
        },
        "responseDetails": {}
      }
    }
  ]
}

but when I remove the plugin, graphql works normally

const yoga = createYoga({
  landingPage: true,
  schema: createSchema({ typeDefs, resolvers }),
  // plugins: [
  //   useSofa({
  //     basePath: '/api',
  //     swaggerUI: {
  //       endpoint: '/swagger'
  //     },
  //     openAPI: {
  //       info: {
  //         title: 'Bun Server REST API',
  //         version: '1.0.0',
  //         description: 'Bun Server REST API'

  //       }
  //     },
  //   })
  // ]
},)

{
  "data": {
    "getPost": null
  }
}

[devhoangkien]

i use bun 1.04

import { createSchema, createYoga } from 'graphql-yoga'
import { BunToText } from './utils/text-logs';
import { readFileSync } from 'node:fs'
import { resolvers } from './modules/app.resolvers';
import { useSofa } from '@graphql-yoga/plugin-sofa'


const typeDefs = readFileSync('./schema.graphql', 'utf8')

const yoga = createYoga({
  landingPage: true,
  schema: createSchema({ typeDefs, resolvers }),
  // plugins: [
  //   useSofa({
  //     basePath: '/api',
  //     swaggerUI: {
  //       endpoint: '/swagger'
  //     },
  //     openAPI: {
  //       info: {
  //         title: 'Bun Server REST API',
  //         version: '1.0.0',
  //         description: 'Bun Server REST API'

  //       }
  //     },
  //   })
  // ]
},)

const server = Bun.serve({
  fetch: yoga.fetch.bind(yoga),
  port: Bun.env.PORT || 8888,
  hostname: Bun.env.HOST || 'localhost',
  development: Bun.env.NODE_ENV !== 'production' ? true : false
});
console.info(BunToText)
console.info(
  `Server is running on ${new URL(
    yoga.graphqlEndpoint,
    `http://${server.hostname}:${server.port}`
  )}`
)

[rhino88]

I posted a repro and issue here: #3112

Willing to offer a bounty here if anyone is willing to tackle this.

[SOG-web]

This plugin is not working on nestjs, I followed the instructions, it does not throw any error, but /swagger endpoint does not exist when I try to get it