在现代API开发中,Swagger UI以其直观的界面和强大的功能脱颖而出。本文将手把手教你如何快速安装并使用Swagger UI,助你高效管理API文档!🚀
首先,你需要通过npm安装`swagger-ui`依赖包。打开终端,运行以下命令:
```bash
npm install swagger-ui-dist
```
完成安装后,在你的项目中引入`swagger-ui-bundle.js`和`swagger-ui.css`文件。例如:
```html
<script src="node_modules/swagger-ui-dist/swagger-ui-bundle.js"></script>
```
接下来,创建一个HTML页面,并初始化Swagger UI。只需一行代码即可:
```javascript
window.onload = function() {
const ui = SwaggerUIBundle({
url: "your-api-docs.json", // 替换为你的API文档地址
dom_id: 'swagger-ui'
});
};
```
最后,启动服务器并访问页面,你会发现API接口清晰呈现,交互体验极佳!✨
掌握Swagger UI后,API文档不再是难题,快来试试吧!💪