matomo-org/matomo

Create a config file for Open API and/or Swagger

开放

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

在 GitHub 查看贡献者指南
 (12 条评论) (2 个反应) (0 位负责人)PHP (2,890 个派生)batch import
EnhancementHelp wantedc: APIsc: Documentationc: Platform

仓库指标

星标
 (21,796 个星标)
PR 合并指标
 (平均合并 8天 11小时) (30 天内合并 106 个 PR)

描述

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

贡献者指南

研究方向
探索Matomo现有的API端点，创建一个描述可用端点、参数和响应的OpenAPI规范文件（例如openapi.json）。查看其他PHP项目如何生成OpenAPI规范。
技术栈
php
领域
backend
议题类型
功能
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
半天
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
PHPOpenAPI/SwaggerREST API
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
60