search

dzhurey / helat-js

This is just our playgroud to learn full stack javascript web application
0 stars 1 forks source link

Auto-generate API Documentation #6

Open dzhurey opened 4 years ago

dzhurey commented 4 years ago

Implementing swagger-jsdoc to auto-generate API documentation and use swagger-ui-express to serve API documentation page. You can see this tutorial to do this task.

If you have another recommended tool to do this, you can reply here

wlwtvr commented 4 years ago

mau pake stoplight aja buat API docnya?

dzhurey commented 4 years ago

mau pake stoplight aja buat API docnya?

stoplight bisa auto-generated juga kah? setauku stoplight ada di cloud terus kita masih musti bikin2 sendiri di app nya dia

wlwtvr commented 4 years ago

Auto-generate ada tapi dibalik, dari design ke code, nggak code ke design hehe

Aku mikirnya buat declutter kode backend, swagger-jsdoc sebenernya juga nggak bener2 auto kan? tetep harus ngasi komen di atas route? 🤔 cmiiw

dzhurey commented 4 years ago

iyo seh ngga auto banget, kita yg harus ngasih definisi dalam bentuk comments

iya sih kalo pake spotlight ngga ngotorin code, tapi kalo ngga ada itu juga kayanya ngga ada comment blas di code wkwkkw