matomo-org/matomo

Create a config file for Open API and/or Swagger

Open

#20,255 创建于 2023年1月23日

在 GitHub 查看
 (12 评论) (2 反应) (0 负责人)PHP (21,513 star) (2,847 fork)batch import
EnhancementHelp wantedc: APIsc: Documentationc: Platform

描述

Users who are testing their API with Postman or setting up security or other tasks sometimes ask for a definition file for our APIs.

贡献者指南

技术栈
phprest api
领域
backendapidocumentation
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
OpenAPI specification knowledgeMatomo API familiarityPHP basics
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
70
研究方向
Investigate the existing Matomo API endpoints defined in the codebase (likely in /plugins/API). Look for any existing Swagger documentation or automate generation using tools like swagger php. Create an OpenAPI config file that describes the available API methods and their parameters. Consider linking with Postman import functionality. Check comments in the issue for any preferences on format (OpenAPI vs Swagger).