TE
TechEcho
Home24h TopNewestBestAskShowJobs
GitHubTwitter
Home

TechEcho

A tech news platform built with Next.js, providing global tech news and discussions.

GitHubTwitter

Home

HomeNewestBestAskShowJobs

Resources

HackerNews APIOriginal HackerNewsNext.js

© 2025 TechEcho. All rights reserved.

Ask HN: Node.js API Documentation

6 pointsby devfatiguealmost 4 years ago
What do you use to get a swagger.json or similar for api documentation?<p>In the dotnet world there is swashbuckle. Is there a node equivalent or better?

2 comments

Raed667almost 4 years ago
I have been using tsoa to generate API documentation from TypeScript types. <a href="https:&#x2F;&#x2F;github.com&#x2F;lukeautry&#x2F;tsoa" rel="nofollow">https:&#x2F;&#x2F;github.com&#x2F;lukeautry&#x2F;tsoa</a><p>Example project: <a href="https:&#x2F;&#x2F;github.com&#x2F;RaedsLab&#x2F;demo-project&#x2F;blob&#x2F;master&#x2F;backend&#x2F;src&#x2F;controller&#x2F;todo.ts" rel="nofollow">https:&#x2F;&#x2F;github.com&#x2F;RaedsLab&#x2F;demo-project&#x2F;blob&#x2F;master&#x2F;backend...</a>
评论 #27281872 未加载
评论 #27273058 未加载
Sheepsteakalmost 4 years ago
I think the official swagger-node (<a href="https:&#x2F;&#x2F;github.com&#x2F;swagger-api&#x2F;swagger-node" rel="nofollow">https:&#x2F;&#x2F;github.com&#x2F;swagger-api&#x2F;swagger-node</a>) hasn&#x27;t been updated for a while. There is swagger-jsdoc (<a href="https:&#x2F;&#x2F;www.npmjs.com&#x2F;package&#x2F;swagger-jsdoc" rel="nofollow">https:&#x2F;&#x2F;www.npmjs.com&#x2F;package&#x2F;swagger-jsdoc</a>) though.