Please update example folder for typescript

giabao1008 commented 1 year ago

Prerequisites

[X] I have written a descriptive issue title
[X] I have searched existing issues to ensure the feature has not already been requested

🚀 Feature Proposal

currently im working with fastify swagger and typescript, follow as example folder. but when use exposeRoute option, it will prompt error

Motivation

No response

Example

.register(swagger, {
    swagger: {
      info: {
        title: 'Test swagger',
        description: 'testing the fastify swagger api',
        version: '0.1.0',
      },
      host: 'localhost:3000',
      schemes: ['http'],
      consumes: ['application/json'],
      produces: ['application/json'],
      swagger: '2.0',
    },
    exposeRoute: true,
    // routePrefix: '/swagger-docs',
  })

Uzlopak commented 1 year ago

Can provide a PR please?

giabao1008 commented 1 year ago

i cant, please help

climba03003 commented 1 year ago

Remove routePrefix: '/swagger-docs', as you show in your example.

giabao1008 commented 1 year ago


  .register(swagger, {
    swagger: {
      info: {
        title: 'Test swagger',
        description: 'testing the fastify swagger api',
        version: '0.1.0',
      },
      basePath: '/',
      consumes: ['application/json'],
      host: 'localhost',
      swagger: '2.0',
    },
    // exposeRoute: true,
    // routePrefix: '/swagger-docs',
  });`` 
yes, i removed but, seem the path /documentation not work

Uzlopak commented 1 year ago

Please read migration.md

giabao1008 commented 1 year ago

one more question, i ve connected swagger to fastify with swagger ui, define a router with schema, but in swagger doc, it not auto generated

this is my config

await fastify.register(fastifySwagger, {
    swagger: {
      info: {
        title: ' Swagger',
        description: 'Testing swagger API',
        version: '0.1.0',
      },
      host: `${HOST}:${PORT}`,
      schemes: ['http'],
      consumes: ['application/json'],
      produces: ['application/json'],
      swagger: '2.0',
    },
  });
  await fastify.register(fastifySwaggerUi, {
    routePrefix: '/v1/example/docs',
    initOAuth: {},
    uiConfig: {
      docExpansion: 'full',
      deepLinking: false,
    },
    uiHooks: {
      onRequest: function (request, reply, next) {
        next();
      },
      preHandler: function (request, reply, next) {
        next();
      },
    },
    staticCSP: true,
    transformStaticCSP: (header) => header,
  });

and router

fastify.get(
    '/',
    {
      schema: {
        description: 'This is an endpoint for fetching all users',
        tags: ['users'],
        response: {
          200: {
            description: 'Success Response',
            type: 'array',
            items: {
              type: 'object',
              properties: {
                id: { type: 'number' },
                name: { type: 'string' },
                age: { type: 'number' },
                createdAt: { type: 'string' },
                updatedAt: { type: 'string' },
              },
            },
          },
        },
      },
    },
    async function (request: FastifyRequest, reply: FastifyReply) {
      return fastify.exampleService.getAll();
    }
  );

please advise me