Swagger API Documentation in NodeJS

Question

I am facing the problem in setting up Swagger. How can I implement Swagger to in my node-express project to write API Doc for existing APIs? I have looked swagger, swagger-ui, and swagger-ui-dist npm packages. But not getting the desired output. I want to use Swagger UI but getting counfused in the confugurations. Can anybody tell me the step by step guide for the configuration? Need help.

You might be looking for https://www.npmjs.com/package/swagger-node-express — Helen, Jul 06 '18 at 11:57

score 0 · Answer 1 · answered Jul 06 '18 at 11:59

0

A good option for beginners is to install the Swagger NPM package https://www.npmjs.com/package/swagger and follow the instructions.

Overview:

// install
npm install -g swagger

// create a new project
swagger project create hello-world

// edit your API using the Swagger UI
swagger project edit

Then follow the rest of the instructions on how to code up your controllers.

answered Jul 06 '18 at 11:59

GreensterRox

6,432
2
27
30

I have implemented this. But I want to use Swagger UI – Asad Marfani Jul 06 '18 at 12:03
`swagger project edit` will give you access to the Swagger UI (launches it in a browser) or is this not what you mean? – GreensterRox Jul 06 '18 at 13:21

score 0 · Accepted Answer · answered Jul 06 '18 at 12:06

0

After basic installation:

Here is a STEP-BY-STEP guide.

Hope this is what you are looking for.

answered Jul 06 '18 at 12:06

Harshal Yeole

4,812
1
21
43

Thanks man. Although it doesn't completely solve my problem but gave hint to me :) Its now been solved. – Asad Marfani Jul 09 '18 at 09:54
Cool. Let me know if you need anything. – Harshal Yeole Jul 09 '18 at 09:57
Yeah sure buddy ! – Asad Marfani Jul 09 '18 at 10:06

Swagger API Documentation in NodeJS

2 Answers2