archived-MoviePilot-Plugins/docs/faq/03-expose-plugin-api.md

如何在插件中对外暴露API？

返回 README | FAQ 索引

• 实现 get_api() 方法，按以下格式返回API列表：

  [{
      "path": "/refresh_by_domain", // API路径，必须以/开始
      "endpoint": self.refresh_by_domain, // API响应方法
      "methods": ["GET"], // 请求方式：GET/POST/PUT/DELETE
      "summary": "刷新站点数据", // API名称
      "description": "刷新对应域名的站点数据", // API描述
  }]
  

  注意：在插件中暴露API接口时注意安全控制，推荐使用settings.API_TOKEN进行身份验证。

• 在对应的方法中实现API响应方法逻辑，通过 http://localhost:3001/docs 查看API文档和调试