api-doc-template/openapi.yaml at main · bundesAPI/api-doc-template · 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
openapi: "3.0.0"
info:
  description: "API Description"
  version: "1.0.0"
  title: "API Name"
  x-office: "Amtsname"
  contact:
    name: Zuständige Behörde
    email: behoerde@example.de
    url: https://example.de

servers:
  - url: "https://warnung.bund.de/api31"

tags:
  - name: default

paths:
  /dashboard/{AGS}.json:
    get:
      summary: Name des Endpoints
      description: Hier wird die Funktion des Endpunktes beschrieben.
      operationId: getAGS
      tags:
        - default
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Result"
      parameters:
        - in: path
          required: true
          name: AGS
          schema:
            type: string
          description: Amtlicher Gebietsschlüssel - kann z.B. von [hier](https://www.xrepository.de/api/xrepository/urn:de:bund:destatis:bevoelkerungsstatistik:schluessel:rs_2021-07-31/download/Regionalschl_ssel_2021-07-31.json) bezogen werden. Die Letzten 7 Stellen müssen dabei mit "0000000" ersetzt werden, weil die Daten nur auf [Kreisebene](https://de.wikipedia.org/wiki/Amtlicher_Gemeindeschl%C3%BCssel) bereitgestellt werden.
          example: "example-parameter"

components:
  schemas:
    Result:
      type: string