peanut-aps/apidoc.json at develop · fca197/peanut-aps · 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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
{
  "name": "My Java API",
  "version": "1.0.0",
  "description": "API documentation for my Java application",
  "title": "My Java API Documentation",
  "url": "https://api.example.com",
  "sampleUrl": "https://api.example.com",
  "header": {
    "title": "API Documentation",
    "content": "This documentation provides detailed information about the API endpoints available in our application."
  },
  "footer": {
    "title": "Contact Information",
    "content": "For support, please contact api-support@example.com"
  },
  "template": {
    "withCompare": true,
    "withGenerator": true,
    "forceLanguage": "en",
    "collapse": {
      "endpoints": false,
      "methods": false
    }
  },
  "markdown": true,
  "filters": [
    ".*\\.java$"
  ],
  "match": {
    "pattern": ".*\\.java$"
  },
  "parse": {
    "filters": [
      {
        "pattern": ".*",
        "match": true
      }
    ]
  },
  "verbose": true,
  "debug": false,
  "silent": false,
  "colorize": true,
  "markdown": true,
  "includeFilters": [
    ".*\\.java$"
  ],
  "excludeFilters": [
    "node_modules",
    "test",
    "docs"
  ],
  "src": [
    "src/main/java"
  ],
  "dest": "doc/api",
  "encoding": "utf8"
}