matomo-org/matomo

Create a config file for Open API and/or Swagger

Aperta

#20.255 aperta il 23 gen 2023

Vedi su GitHubGuida contributor
 (12 commenti) (2 reazioni) (0 assegnatari)PHP (2890 fork)batch import
EnhancementHelp wantedc: APIsc: Documentationc: Platform

Metriche repository

Star
 (21.789 stelle)
Metriche merge PR
 (Merge medio 8g 11h) (106 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Esplora gli endpoint API esistenti di Matomo e crea un file di specifica OpenAPI (es. openapi.json) che descriva gli endpoint disponibili, i parametri e le risposte. Guarda come altri progetti PHP generano specifiche OpenAPI.
Tech stack
php
Dominio
backend
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PHPOpenAPI/SwaggerREST API
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60