API-Specs/index.html at main · mpelley/API-Specs · 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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
<!-- HTML for static distribution bundle build -->
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8">
    <title>Swagger UI</title>
    <link rel="stylesheet" type="text/css" href="./swagger-ui.css" />
    <link rel="stylesheet" type="text/css" href="index.css" />
    <link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32" />
    <link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16" />
  </head>

  <style>
    h1,h2,h3,p,li {
      font-family: sans-serif;
      padding-left: 40px;
    }
    table {
      text-align: left;
      font-family: sans-serif;
      font-size: 1.25em;
      padding-left: 20px;
    }
    td,th {
      padding-left: 10px;
      padding-right: 10px;
      border-bottom: 1px solid black;
    }
  </style>

  <body>
	<h1>Note: These specifications are all incomplete!</h1>
    <h1>Links for the OpenAPI specification of various servers</h1>
    <table>
      <tr>
        <th>Server</th>
        <th>Version</th>
        <th>Link</th>
      </tr>
      <tr>
        <td>Akuo</td>
        <td>1.0</td>
        <td><a href="./Akuo"> Akuo API</a></td>
      </tr>
      <tr>
        <td>Serval</td>
        <td>1.0</td>
        <td><a href="./Serval"> Serval API</a></td>
      </tr>
      <tr>
        <td>Send/Receive</td>
        <td>8.0</td>
        <td><a href="./SendReceive8.0"> Send-Receive API</a></td>
      </tr>
      <tr>
        <td>Send/Receive</td>
        <td>9.4</td>
        <td><a href="./SendReceive9.4"> Send-Receive API</a></td>
      </tr>
      <tr>
        <td>DBL Download</td>
        <td>1.0</td>
        <td><a href="./DBL Download"> DBL Download API</a></td>
      </tr>
      <tr>
        <td>DBL Upload</td>
        <td>1.0</td>
        <td><a href="./DBL Upload"> DBL Upload API</a></td>
      </tr>
    </table>
    <h2> About OpenAPI</h2>
    <p>
    The <a href="https://www.openapis.org/"> OpenAPI Specifications</a> provides a formal standard for describing HTTP APIs.
    This allows people to understand how an API works, how a sequence of APIs work together, generate client code, create tests, apply design standards, and much, much more.
    OpenAPI was previously known as "Swagger".
    A more easily digested guide is <a href="https://swagger.io/docs/specification/about/"> here</a>

    <h3>Creating a specification</h3>
    <p>
    There is a free <a href="https://editor.swagger.io/">OpenAPI editor</a> that helps when writing a specification.
    It does the checking of the specification and shows what it looks like in the interactive UI.

    <h3>Viewing a specification</h3>
    <p>
    This web site provides an interactive specification viewer for the specifications hosted here.
    (The viewer is the open-source <a href="https://swagger.io/tools/swagger-ui/">Swagger UI</a>.)

    <h3>Source Control</h3>
    <p>
    We recommend placing the YAML format of the specification into source control.
    We prefer using YAML instead of JSON because:
    <ul>
    <li> YAML is the native format for the editor </li>
    <li> YAML permits comments </li>
    <li> YAML keeps any blank lines and other formatting you use</li>
    </ul>

    <h2>Adding a specification to this web site</h3>
    <p>
    See <a href="mailto:michael_pelley@sil.org">Mike Pelley</a> to add or update a specification on this web site.
  </body>
</html>