Zum Inhalt

API-Dokumentation

Zur Dokumentation einer API oder Funktionen kann folgende Struktur zum Einsatz kommen:

Hinweis

In der Kopiervorlage wird der Codeabschnitt mittels \ escaped. Dies muss beim Einsatz in der eigenen Dokumentation entfernt werden.

Beispiel

??? summary "function(parameter)"

    **Beschreibung**

    > Beschreibung

    ------------------

    **Parameter-Liste**

    parameter (Types)

    > Beschreibung

    -------------------

    **Rückgabewert**

    > Beschreibung

Ergebnis

function(parameter)

Beschreibung

Beschreibung


Parameter-Liste

parameter (Types)

Beschreibung


Rückgabewert

Beschreibung

Definition einer API

Beispiel

??? summary "Name der API"

    **Beschreibung**

    > Beschreibung

    ------------------

    **URL**: `/api/`

    **Methode**: `GET` | `PUT` | `DELETE` | `POST`

    **Öffentlich**: ja | nein

    ------------------

    **URL-Parameter**

    parameter (Types)

    > Beschreibung

    ------------------

    **Daten**

    \```json
    \```

    -------------------

    **Rückgabewert**

    * Erfolgsfall

      **Code**: `200 OK`

      > Beschreibung

    * Fehlerfall

      **Code**: `404 Not Found` | `500 Server failure`

      > Beschreibung

    -------------------

    **Beispielaufruf**

    \```javascript
    fetch('/', {
        method: 'POST',
        mode: 'cors',
        redirect: 'follow',
        headers: new Headers({
            'Content-Type': 'application/javascript'
        })
    })
    .then(function(response) {
        /* handle response */
    })
    .catch(function(error) {
        /* handle error */
    });
    \```

Ergebnis

Name der API

Beschreibung

Beschreibung


URL: /api/

Methode: GET | PUT | DELETE | POST

Öffentlich: ja | nein


URL-Parameter

parameter (Types)

Beschreibung


Daten

{ }

Rückgabewert

  • Erfolgsfall

Code: 200 OK

Beschreibung

  • Fehlerfall

Code: 404 Not Found | 500 Server failure

Beschreibung


Beispielaufruf

fetch('/', {
    method: 'POST',
    mode: 'cors',
    redirect: 'follow',
    headers: new Headers({
        'Content-Type': 'application/javascript'
    })
})
.then(function(response) {
    /* handle response */
})
.catch(function(error) {
    /* handle error */
});