git-stats/commit-message-api-examples.http at main · leejsinclair/git-stats · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
###
# Commit Message Analyzer API Examples
# Use these examples to test the commit message analysis endpoints
###

### Get Best Practices Information
GET http://localhost:3000/api/commit-messages/best-practices

###
# Analyze Commit Messages in Current Repository
POST http://localhost:3000/api/commit-messages/analyze
Content-Type: application/json

{
  "repoPath": "/home/lee/projects/git-stats",
  "branch": "main",
  "limit": 50
}

###
# Analyze Commit Messages with Date Range
POST http://localhost:3000/api/commit-messages/analyze
Content-Type: application/json

{
  "repoPath": "/home/lee/projects/git-stats",
  "since": "2024-01-01",
  "until": "2026-01-31",
  "limit": 100
}

###
# Analyze Previously Cloned Repository
# First clone a repo using: POST /api/git/analyze/remote
# Then analyze its commit messages using the repo name
POST http://localhost:3000/api/commit-messages/analyze/repo/git-stats
Content-Type: application/json

{
  "branch": "main",
  "limit": 50
}