@halsp/swagger
v2.4.5
Published
使用 swagger 自动生成你的 Halsp 文档
Downloads
2,479
Readme
开始使用
请跟随文档 halsp.org 📚
线上示例
请访问 https://quickstart.halsp.org 🌈
该网站可快速体验 Halsp,代码由
@halsp/cli
生成,运行于 StackBlitz
可以自由选择插件和运行环境,支持在线编辑、运行、调试
介绍
@halsp/swagger
是 Halsp
的 swagger 文档插件
基于 @halsp/validator
,使用装饰器注释文档,可以解析部分 @halsp/validator
的装饰器
在浏览器中使用 swagger-ui 渲染文档
安装
npm install @halsp/swagger
贡献
在提交 PR 前请先阅读 Contributing to Halsp.
遇到问题
首先查找是否已有相关问题:
- 查看文档 halsp.org 是否有相关内容
- 查看 Discussions 是否有相关讨论
- 查看 Issues 是否有相关内容
如果以上没有找到答案:
- 一般性问题请在讨论区提问 Discussions
- 代码问题或不符预期的行为请提 Issues
如果你能通过代码解决这个问题欢迎提交 Pull requests
License
Copyright (c) 2022-present, Hal Wang