@halsp/swagger
TypeScript icon, indicating that this package has built-in type declarations

2.4.3 • Public • Published

Halsp Logo

Halsp - 面向云的现代渐进式轻量 Node.js 框架

GitHub license npm version npm downloads node compatibility Build Status Test Coverage PRs Welcome Gitpod Ready-to-Code

开始使用

请跟随文档 halsp.org 📚

线上示例

请访问 https://quickstart.halsp.org 🌈

该网站可快速体验 Halsp,代码由 @halsp/cli 生成,运行于 StackBlitz

可以自由选择插件和运行环境,支持在线编辑、运行、调试

介绍

@halsp/swaggerHalsp 的 swagger 文档插件

基于 @halsp/validator,使用装饰器注释文档,可以解析部分 @halsp/validator 的装饰器

在浏览器中使用 swagger-ui 渲染文档

安装

npm install @halsp/swagger

贡献

在提交 PR 前请先阅读 Contributing to Halsp.

遇到问题

首先查找是否已有相关问题:

  1. 查看文档 halsp.org 是否有相关内容
  2. 查看 Discussions 是否有相关讨论
  3. 查看 Issues 是否有相关内容

如果以上没有找到答案:

  • 一般性问题请在讨论区提问 Discussions
  • 代码问题或不符预期的行为请提 Issues

如果你能通过代码解决这个问题欢迎提交 Pull requests

License

MIT

Copyright (c) 2022-present, Hal Wang

Readme

Keywords

Package Sidebar

Install

npm i @halsp/swagger

Homepage

halsp.org

Weekly Downloads

1,834

Version

2.4.3

License

MIT

Unpacked Size

234 kB

Total Files

64

Last publish

Collaborators

  • hal-wang