matomo-org/matomo

Create a config file for Open API and/or Swagger

Offen

#20.255 geöffnet am 23.01.2023

Auf GitHub ansehenContributor Guide
 (12 Kommentare) (2 Reaktionen) (0 zugewiesene Personen)PHP (2.894 Forks)batch import
EnhancementHelp wantedc: APIsc: Documentationc: Platform

Repository-Metriken

Stars
 (21.803 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

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

Research-Richtung
Erkunde die vorhandenen API Endpunkte von Matomo und erstelle eine OpenAPI Spezifikationsdatei (z.B. openapi.json), die die verfügbaren Endpunkte, Parameter und Antworten beschreibt. Schau dir an, wie andere PHP Projekte OpenAPI Spezifikationen generieren.
Tech Stack
php
Domain
backend
Issue Type
Funktion
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.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
PHPOpenAPI/SwaggerREST API
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60