温馨提示×

Swagger API文档在Linux上如何展示

小樊
64
2025-04-15 04:10:52
栏目: 智能运维

在Linux上展示Swagger API文档,可以通过以下几种方法实现:

使用Swagger Editor

  1. 安装Swagger Editor
  • 可以通过包管理器安装,例如在Ubuntu上使用以下命令:
    sudo apt-get update sudo apt-get install swagger-editor 
  • 或者下载Swagger Editor的压缩包并解压到指定目录。
  1. 导入Swagger JSON文件
  • 启动Swagger Editor后,可以通过“File” -> “Import”导入你的Swagger JSON文件。
  1. 访问文档
  • 打开浏览器,访问http://localhost:3000即可看到Swagger Editor界面,并可以查看和编辑API文档。

使用NestJS和Swagger

  1. 创建NestJS项目
nest new swagger-demo -p npm cd swagger-demo 
  1. 安装Swagger依赖
npm install --save @nestjs/swagger 
  1. 配置Swagger文档: 在主入口文件main.ts中添加以下代码:
import { DocumentBuilder } from '@nestjs/swagger'; import { SwaggerModule } from '@nestjs/swagger'; import { AppModule } from './app.module'; const documentConfig = new DocumentBuilder() .setTitle('Swagger Example') .setDescription('The API description') .setVersion('1.0') .addTag('swagger') .build(); @Module({ imports: [ AppModule, SwaggerModule.register({ document: documentConfig, cors: true, }), ], controllers: [], providers: [], }) export class AppModule {} 
  1. 启动项目
npm run start:dev 
  1. 访问文档: 打开浏览器,访问http://localhost:3000/doc即可看到Swagger API文档。

使用Go语言和Gin框架

  1. 安装go-swagger工具
go install github.com/swaggo/swag/cmd/swag@latest 
  1. 生成Swagger文档: 在项目根目录下运行以下命令:
swag init 
  1. 访问文档: 启动Gin应用后,访问http://localhost:8080/swagger/index.html即可看到Swagger API文档。

通过以上方法,你可以在Linux系统上成功展示Swagger API文档。选择适合你项目的方法进行操作即可。

0