fastify.ready() with fastify-cli about fastify-swagger

[mcollina]

Oh, you'll need the exposeRoute: true option.

[lgertel]

Great, working now!
One little thing: On the Usage section on README.md - there is a extra {}

fastify.register(require('fastify-swagger'), {
  swagger: {
    info: {
      title: 'Test swagger',
      description: 'testing the fastify swagger api',
      version: '0.1.0'
    },
    routePrefix: '/documentation',
    host: 'localhost',
    schemes: ['http'],
    consumes: ['application/json'],
    produces: ['application/json'],
    securityDefinitions: {
      apiKey: {
        type: 'apiKey',
        name: 'apiKey',
        in: 'header'
      }
    }
  }
})

This doesn't work!

Here is my version:

fastify.register(require('fastify-swagger'), {
    swagger: {
      info: {
        title: 'EDS Cognitive',
        description: 'Testing the fastify swagger api',
        version: '0.1.0'
      },
    },
    exposeRoute: true,
    routePrefix: '/documentation'
  })

Not sure why but....
Thanks a lot.
We will start to use fastify on a big enterprise project, you'll see me a lot here...lol

cya

[mcollina]

I'm a bit lost. What do you mean? Can you make a full example?

[lgertel]

I'm trying to add fastify-swagger on my project. The project was created with fastify-cli!
This is my app.js:

module.exports = function (fastify, opts, next) {

  fastify.register(require('@now-ims/fastify-firestore'), {
    projectId: 'nomikos-544df',
    keyFilename: './nomikos-78ff516da5d8.json'
  })

  fastify.register(require('fastify-swagger'), {
    swagger: {
      info: {
        title: 'Test swagger',
        description: 'testing the fastify swagger api',
        version: '0.1.0'
      },
      routePrefix: '/documentation',
      host: 'localhost',
      schemes: ['http'],
      consumes: ['application/json'],
      produces: ['application/json'],
      securityDefinitions: {
        apiKey: {
          type: 'apiKey',
          name: 'apiKey',
          in: 'header'
        }
      }
    }
  })

  // This loads all plugins defined in plugins
  // those should be support plugins that are reused
  // through your application
  fastify.register(AutoLoad, {
    dir: path.join(__dirname, 'plugins')
  })

  // This loads all plugins defined in services
  // define your routes in one of these
  fastify.register(AutoLoad, {
    dir: path.join(__dirname, 'services')
  })

  // Make sure to call next when done
  next()
}

In the documentation i saw that it's necessary to add the command below but I'm not sure where to put it, as the server is initialised by fastify start command.

fastify.swagger()

[mcollina]

fastify.swagger() will just return the swagger definition. You do not have to do much, just navigate to /documentation and your swagger-ui should appear.

Is it working?

[lgertel]

But where to add the fastify.swagger() ? On the route?

My root.js

'use strict'

module.exports = function (fastify, opts, next) {
  const options = {
    schema: {
      response: {
        200: {
          type: 'object',
          properties: {
            root: { type: 'boolean' }
          }
        }
      }
    }
  }

  fastify.get('/', options, function (request, reply) {
    reply.send({ root: true })
  })

  next()
}

// 20180611161700
// http://localhost:3000/documentation

{
  "statusCode": 404,
  "error": "Not Found",
  "message": "Not Found"
}

[mcollina]

@lgertel would you like to send a PR to update the README?

I'm glad you picked fastify!

[lgertel]

@mcollina yeah! sure!
I'll work on this and send news asap.

Who knows, maybe sometime I'll be able to work on the core too :)

[radvansky-tomas]

Doesnt work for me, with current CLI create and having multiple folders in services folder. swagger docs is only shown for routes defined in app.js, root where are registrations

[mcollina]

Can you please paste your app.js?

[radvansky-tomas]

"use strict";
const PORT = process.env.PORT || 3000;
const path = require("path");
const AutoLoad = require("fastify-autoload");
const fastify = require("fastify")({
  logger: true
});
// Require external modules
const mongoose = require("mongoose");

// Connect to DB
mongoose
  .connect("mongodb://localhost:27017/navrush")
  .then(() => console.log("MongoDB connected…"))
  .catch(err => console.log(err));

// Place here your custom code!

// Do not touch the following lines

// This loads all plugins defined in plugins
// those should be support plugins that are reused
// through your application
fastify.register(AutoLoad, {
  dir: path.join(__dirname, "plugins")
});

// This loads all plugins defined in services
// define your routes in one of these
fastify.register(AutoLoad, {
  dir: path.join(__dirname, "services")
});

// Register Swagger
fastify.register(require('fastify-swagger'), {
  swagger: {
    info: {
      title: 'EDS Cognitive',
      description: 'Testing the fastify swagger api',
      version: '0.1.0'
    },
  },
  exposeRoute: true,
  routePrefix: '/documentation'
})

fastify.listen(PORT, err => {
  if (err) throw err;
  console.log(`server listening on ${fastify.server.address().port}`);
});

fastify.ready(err => {
  if (err) throw err;
  fastify.swagger();
});

[radvansky-tomas]

[radvansky-tomas]

If I add any schema definition to services/auth/index,js there are not part of swagger generated docs

[mcollina]

that needs to be loaded before the autoload calls. There is a comment at the top where to add your plugins.

[radvansky-tomas]

Thank you, works. Please try to add this to main example, as this is what you will get if you follow guides :D

[Armania]

This also worked for me,

I was trying to install @fastify/swagger-ui but was getting an error.
-> AssertionError [ERR_ASSERTION]: The dependency '@fastify/swagger' of plugin '@fastify/swagger-ui' is not registered

I tried just registering fastify-swagger, via "autoload" but adding a file for swagger. but that did not work. But i did not have the exposeRoute: true option.

/app.js
// ... fastify.register(require("@fastify/swagger"), { swagger: { info: { title: "Armani Machines", description: "Api documentation test using Swagger/Swaggerui", version: "0.1.0", }, }, exposeRoute: true, routePrefix: "/documentation", uiConfig: { docExpansion: "full", deepLinking: false, }, }); // ...

This code worked for me