matomo-org/matomo

Create a config file for Open API and/or Swagger

Open

#20.255 geöffnet am 23. Jan. 2023

Auf GitHub ansehen
 (12 Kommentare) (2 Reaktionen) (0 zugewiesene Personen)PHP (21.513 Stars) (2.847 Forks)batch import
EnhancementHelp wantedc: APIsc: Documentationc: Platform

Beschreibung

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

Contributor Guide

Tech Stack
phprest api
Domain
backendapidocumentation
Issue Type
feature
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 hours
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
fresh
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
mostly clear
Voraussetzungen
OpenAPI specification knowledgeMatomo API familiarityPHP basics
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70
Research-Richtung
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).