在Ubuntu里管理Swagger,可参考以下方法:
可通过包管理器安装,如sudo apt-get install swagger-jsdoc swagger-ui-express
。也可使用npm安装,先安装Node.js和npm,再执行npm install -g swagger-ui-express
等命令。还能用Docker安装,拉取镜像并运行容器,如docker run -p 8080:8080 swaggerapi/swagger-ui-express
。
创建swagger.json
或swagger.yaml
文件,定义API元数据。若使用Express框架,可通过swagger-ui-express
中间件集成Swagger UI,示例代码为app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument))
。
在项目中创建swaggerConfig.js
等配置文件,通过管理不同版本的API路由文件路径,来实现Swagger的版本控制。
使用Swagger Editor编辑和查看API文档,通过访问http://localhost:8080
(默认端口)进行操作。