在Debian上生成Swagger文档,有基于Java和Node.js两种常见方式,以下是具体步骤:
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
swagger.yaml
或swagger.json
文件,定义API的端点、参数等。java -jar swagger-codegen-cli.jar generate -i path/to/swagger.yaml -l html2 -o path/to/output/directory
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规范。swagger-ui-express
,配置并启动应用,通过访问http://localhost:端口号/api-docs
查看文档。