debian

Debian上Swagger文档如何生成

小樊
38
2025-09-02 23:28:12
栏目: 智能运维

在Debian上生成Swagger文档,有基于Java和Node.js两种常见方式,以下是具体步骤:

基于Java(适用于Spring Boot项目)

  1. 安装工具:安装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
    
  2. 编写API规范:创建swagger.yamlswagger.json文件,定义API的端点、参数等。
  3. 生成文档:使用Swagger Codegen CLI生成HTML等格式的文档。
    java -jar swagger-codegen-cli.jar generate -i path/to/swagger.yaml -l html2 -o path/to/output/directory
    
  4. 集成到构建过程(可选):将Swagger Codegen集成到Maven或Gradle构建中,实现自动生成。

基于Node.js

  1. 安装工具:安装Node.js、npm,然后全局安装swagger-jsdocswagger-ui-express
    sudo apt update
    sudo apt install nodejs npm
    sudo npm install -g swagger-jsdoc swagger-ui-express
    
  2. 准备配置:创建swagger.jsonswagger.yaml文件,描述API规范。
  3. 生成文档并集成到应用:在Express应用中引入swagger-ui-express,配置并启动应用,通过访问http://localhost:端口号/api-docs查看文档。

0
看了该问题的人还看了