在Ubuntu上编写Swagger API文档,可参考以下步骤:
- 安装Swagger工具:先安装Node.js和npm,再使用npm全局安装Swagger UI和Swagger Editor,命令为
sudo apt update,sudo apt install nodejs npm,npm install -g swagger-ui-express swagger-editor-cli。 - 创建OpenAPI规范文件:用Swagger Editor编写API规范,可在线编辑或通过
swagger-editor-cli start在本地浏览器中编辑,保存为YAML或JSON格式,如swagger.yaml或swagger.json。 - 集成到应用(可选):若使用Node.js应用,可通过
swagger-ui-express中间件集成Swagger UI,将规范文件路径配置到代码中,启动应用后访问相应端口查看文档。