search

restSampleServices / node-service

the rest service
Apache License 2.0
0 stars 0 forks source link

show or link service documentation #19

Open blndev opened 7 years ago

blndev commented 7 years ago

maybe we can use a md - browser viewer or we should create a build step to place a html based documentation in html folder.

Research: Swagger for ExpressJS

blndev commented 7 years ago

Swagger seems to overblown currently. Different than in Java or C# you have to write a swagger.json for a express service by hand.

Better approach: https://github.com/evilstreak/markdown-js https://www.npmjs.com/package/markdown-to-html

blndev commented 7 years ago

MD to HTML used by Google: https://github.com/showdownjs/showdown