New Case Study:See how Anthropic automated 95% of dependency reviews with Socket.Learn More
Socket
Sign inDemoInstall
Socket

swagger-ts-doc

Package Overview
Dependencies
Maintainers
1
Versions
14
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

swagger-ts-doc

swagger-ts-doc 的灵感来自于swagger-jsdoc, swagger-jsdoc 会根据注释来生成对应的swagger描述, 搭配swagger-ui-express可以实现比较好的API文档,那么这里swagger-ts-doc 则是利用typescript 强类型的特新去生成swagger描述。

  • 1.0.13
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

swagger-ts-doc

swagger-ts-doc 的灵感来自于swagger-jsdoc, swagger-jsdoc 会根据注释来生成对应的swagger描述, 搭配swagger-ui-express可以实现比较好的API文档,那么这里swagger-ts-doc 则是利用typescript 强类型的特新去生成swagger描述。

目标

swagger-ts-doc 参照了java的swagger文档生成方式,可以提供强类型的描述去产生对应的swagger API文档描述。

安装

$ npm install swagger-ts-doc --save

快速入门

Get started by documenting your code.

Demo 程序

$ git clone https://github.com/wz2cool/swagger-ts-doc-demo.git
$ cd swagger-ts-doc-demo
$ npm install
$ npm start

打开浏览器:http://localhost:3000/api-docs

FAQs

Package last updated on 14 Apr 2018

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc