阅读量:2
在Debian上生成Swagger文档,有基于Java和Node.js两种常见方式,以下是具体步骤:
基于Java(适用于Spring Boot项目)
- 安装工具:安装Java JDK、Maven或Gradle,以及Swagger Codegen。
sudo apt update sudo apt install openjdk-11-jdk maven gradle wget https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.29/swagger-codegen-cli-3.0.29.jar -O swagger-codegen-cli.jar - 编写API规范:创建
swagger.yaml或swagger.json文件,定义API的端点、参数等。 - 生成文档:使用Swagger Codegen CLI生成HTML等格式的文档。
java -jar swagger-codegen-cli.jar generate -i path/to/swagger.yaml -l html2 -o path/to/output/directory - 集成到构建过程(可选):将Swagger Codegen集成到Maven或Gradle构建中,实现自动生成。
基于Node.js
- 安装工具:安装Node.js、npm,然后全局安装
swagger-jsdoc和swagger-ui-express。sudo apt update sudo apt install nodejs npm sudo npm install -g swagger-jsdoc swagger-ui-express - 准备配置:创建
swagger.json或swagger.yaml文件,描述API规范。 - 生成文档并集成到应用:在Express应用中引入
swagger-ui-express,配置并启动应用,通过访问http://localhost:端口号/api-docs查看文档。
以上就是关于“Debian上Swagger文档如何生成”的相关介绍,筋斗云是国内较早的云主机应用的服务商,拥有10余年行业经验,提供丰富的云服务器、租用服务器等相关产品服务。云服务器资源弹性伸缩,主机vCPU、内存性能强悍、超高I/O速度、故障秒级恢复;电子化备案,提交快速,专业团队7×24小时服务支持!
简单好用、高性价比云服务器租用链接:https://www.jindouyun.cn/product/cvm