How do I view the swagger UI?

[RotemBot]

I have ./swagger/swagger.json and ./config/swaggergeberator.js

How do I view the swagger UI?

[theoomoregbee]

check #27

[RotemBot]

Saw that, but unclear how to extract /dist

[theoomoregbee]

I think I need to add an option to expose a route for swagger UI since it has been asked before. What do you think?

[RotemBot]

Sound good :)

[tomsaleeba]

You can use one of these inline route functions to expose the swagger.json.

An example (defined in config/routes.js):

  'get /swagger.json': (_, res) => {
    const swaggerJson = require('../swagger/swagger.json')
    if (!swaggerJson) {
      res
        .status(404)
        .set('content-type', 'application/json')
        .send({message: 'Cannot find swagger.json, has the server generated it?'})
    }
    return res
      .status(200)
      .set('content-type', 'application/json')
      .send(swaggerJson)
  }

Just note that as of 6b38ae3 defining one of these inline functions will cause this swagger-generator hook to explode on sails lift. I've got a commit that stops the explosion: tomsaleeba@4036f25. Hopefully I'll get time to make it actually process the route and produce the correct swagger definition.

[theoomoregbee]

@tomsaleeba with version v2.2.1 you can specify which directory to place the generated swagger JSON in. So putting it in assets folder which sails will automatically expose for you via http://localhost:1337/swagger.json. https://sailsjs.com/documentation/concepts/assets

The other thing is to specify a view to render from config/routes.js then find a way to skip such views when generating the swagger.json

This can be helpful too https://sailsjs.com/documentation/reference/configuration/sails-config-views

[bhaveshbheda]

copy generated json file to .temp/public dir
so you can access it by http://localhost:1337/swagger.json

[bilal68]

to view the swagger file swagger-ui is installed separately? @Theo4u

[theoomoregbee]

yeah @bilal68

[bilal68]

@Theo4u can you please guide me through the steps i am new to sails.
I installed the swagger-ui...where to set the route?and I am not seeing index.html file in swagger-ui/dist.