温馨提示×

Linux中Swagger如何生成交互式API文档

小樊
47
2025-08-13 03:29:06
栏目: 智能运维

在Linux中生成交互式API文档,通常有以下两种常见方式:

基于Spring Boot项目(Java语言)

  1. 安装Swagger依赖:在pom.xml中添加springfox-swagger2springfox-swagger-ui依赖。
  2. 配置Swagger:创建配置类,使用@EnableSwagger2注解,指定API的基本信息、扫描的包路径等。
  3. 编写API代码:在Controller中使用@Api@ApiOperation等注解描述API。
  4. 访问文档:启动Spring Boot应用,访问http://localhost:8080/swagger-ui.html查看交互式文档。

基于Node.js项目

  1. 安装工具:用npm安装swagger-jsdocswagger-ui-express
  2. 编写规范文件:创建swagger.yamlswagger.json文件,用OpenAPI规范定义API。
  3. 集成到项目:在Express应用中引入swagger-ui-express,将规范文件作为参数传入setup方法。
  4. 查看文档:启动项目后,访问http://localhost:3000/api-docs(端口可自定义)查看文档。

0