Repository navigation
Implemented on Lambda Handler Functions yields missing info object error! #319
Description
Describe the bug
When running the swagger-jsdoc command on the definition file I keep getting:
$> yarn swagger-jsdoc -d ./swaggerDef.js
yarn run v1.22.17
$ /Userscolldude/apihhooks/app/node_modules/.bin/swagger-jsdoc -d ./swaggerDef.js
Definition file should contain an info object!
More at http://swagger.io/specification/#infoObjectTo Reproduce
Steps to reproduce the behavior:
1: Create lambda handler method
2: Add swagger or openapi commend.
3: create SW Deffinition file referencing the handler file.
// IMPORTS GO HERE
/**
* @openapi
* /:
* get:
* description: Welcome to swagger-jsdoc!
* responses:
* 200:
* description: Returns a mysterious string.
*/
export const handler = async (request) => {
try {
// LOGIC GOES HEREE
return responseSuccess({ data: subscription })
} catch (error) {
return error
}
}
deffinition file:
const swaggerJsdoc = require('swagger-jsdoc')
const options = {
swaggerDefinition: {
openapi: '3.0.0',
info: {
title: 'Hello World',
version: '1.0.0',
},
},
apis: ['./webhooks/webhookscreate.js'],
}
const openapiSpecification = swaggerJsdoc(options)
Expected behavior
I am expecting a swagger json output to use with swagger ui
Screenshots
If applicable, add screenshots to help explain your problem.
Desktop (please complete the following information):
- OS: Mac
- Node: v14.18.3
- Yarn: 1.22.17
- NPM: 6.14.15
I am looking for a way to generate Swagger deffinition files to use with swagger UI in the same way that .net core uses Swashbuckle.
Activity
daniloab commentedon Apr 19, 2022
Hi, @pjcjonas
Seems you have a project named
/apihhooks/app/. Can you provide a tiny repo reproducing the error that are you getting it?pjcjonas commentedon Apr 19, 2022
I sort that out ASAP, in the mean time I fixed it by creating the swagger.js file below and running
node swagger.jsthat then generates the json file for me included at the end:OUTPUT
{ "openapi": "3.0.0", "info": { "title": "Hello World", "description": "A sample API", "version": "1.0.0" }, "paths": { "/": { "get": { "description": "QQQQ Welcome to swagger-jsdoc!", "responses": { "200": { "description": "Returns a mysterious string." } } } } }, "components": {}, "tags": [] }daniloab commentedon Apr 19, 2022
Awesome, I was debugging here. So, can we consider that this is working for you?
pjcjonas commentedon Apr 19, 2022
I works when I used the
node index.jsmethod using fs to write a file to the file system, but not theyarn swagger-jsdocmethod.So its working in a way but not sure if it is suppose to work using the yarn swagger-jsdoc by referencing the definition file and supplying an output
https://github.com/pjcjonas/swagger-jsodc-test/tree/master