Cum să folosești API-ul Codacy pentru proiecte — Ghid pas cu pas

In this tutorial, you'll learn about Cum să folosești API. We cover key concepts, practical examples, and best practices to help you understand and apply this topic effectively.

Folosești API-ul Codacy pentru proiecte pentru a automatiza gestionarea calității codului. API-ul REST permite citirea metricilor, issue-urilor și coverage-ului fără a intra în interfața web.

Step-by-Step Fix

1. Obține API token

Din Codacy, Settings > Integrations > Project API > generează token.

export CODACY_API_TOKEN=your-api-token

2. Listează proiecte

curl -H "api-token: $CODACY_API_TOKEN" \
  https://app.codacy.com/api/v3/projects

{
  "data": [
    {
      "id": "12345",
      "name": "my-project",
      "owner": "my-org",
      "repository": {
        "provider": "gh",
        "owner": "my-org",
        "name": "my-project]
      }
    }
  ]
}

3. Obține metricile proiectului

curl -H "api-token: $CODACY_API_TOKEN" \
  https://app.codacy.com/api/v3/projects/{owner}/{repo}/metrics

4. Creează un raport custom

import requests

API_TOKEN = "your-token"
headers = {"api-token": API_TOKEN}

response = requests.get(
  f"https://app.codacy.com/api/v3/projects/{owner}/{repo}/issues",
  headers=headers
)
data = response.json()

print(f"Total issues: {data['total']}")
print(f"Errors: {data['counts']['Error']}")
print(f"Warnings: {data['counts']['Warning']}")

Common Mistakes

1. Token în clar în cod -- folosește variabile de mediu sau vault pentru token
2. Rate limit depășit -- API-ul Codacy are rate limit; evită request-uri în buclă
3. Endpoint greșit -- verifică versiunea API (v3) și path-ul corect
4. Paginație ignorată -- rezultatele sunt paginate; folosește limit și offset
5. Autentificare greșită -- token-ul se trimite ca header api-token, nu ca bearer

Practice Exercise

Scrie un script Python care folosește API-ul Codacy pentru a extrage numărul de issue-uri dintr-un proiect și a genera un raport JSON săptămânal.

FAQ

Construit de dezvoltatorii Doda Browser, DodaZIP și Durga Antivirus Pro.