|
2 | 2 |
|
3 | 3 | Herzlich willkommen zum Workshop API Design. |
4 | 4 |
|
5 | | -## Übungen |
| 5 | +## Aufgabe: Design einer RESTful API |
6 | 6 |
|
7 | | -### API Design |
| 7 | +Bitte designen Sie eine API zur Kundenverwaltung. |
| 8 | +- Man kann sich alle Kunden anschauen |
| 9 | +- Man kann einen Kunden anlegen |
| 10 | +- Man kann sich die Detail-Informationen eines Kunden anschauen |
| 11 | +- Ein Kunde hat bis zu zwei Adressen: |
| 12 | +eine Rechnungsadresse und eine Lieferadresse |
| 13 | +- Man kann die Rechnungsadresse und die Lieferadresse ändern. |
8 | 14 |
|
9 | | -- [OpenAPI](https://github.com/openknowledge/workshop-api-design/tree/openapi) |
10 | | -- [Mocking](https://github.com/openknowledge/workshop-api-design/tree/wiremock) |
11 | | -- [AsyncAPI](https://github.com/openknowledge/workshop-api-design/tree/asyncapi) |
| 15 | +## Verwendung des Swagger-Editors |
12 | 16 |
|
13 | | -### API Testing |
| 17 | +Bitte beschreiben Sie die API im OpenAPI-Format. |
| 18 | +Verwenden Sie dazu den Swagger-Editor |
14 | 19 |
|
15 | | -- [Pact](https://github.com/openknowledge/workshop-api-design/tree/pact-mock-server) |
16 | | -- [Pact Pipeline](https://github.com/openknowledge/workshop-api-design/tree/pact) |
| 20 | +### Starten des Swagger-Editors |
17 | 21 |
|
18 | | -### API Security |
| 22 | +Mit folgendem Befehl kann der Swagger-Editor gestartet werden: |
| 23 | +``` |
| 24 | +docker compose up |
| 25 | +``` |
19 | 26 |
|
20 | | -- [JWT](https://github.com/openknowledge/workshop-api-design/tree/jwt) |
21 | | -- [OAuth2](https://github.com/openknowledge/workshop-api-design/tree/oauth2) |
22 | | -- [OAuth2 mit PKCE](https://github.com/openknowledge/workshop-api-design/tree/oauth2-pkce) |
| 27 | +### Öffnen des Swagger-Editors |
23 | 28 |
|
24 | | -### API Governance |
25 | | - |
26 | | -- [Linting](https://github.com/openknowledge/workshop-api-design/tree/linting) |
27 | | - |
28 | | -### API Management |
29 | | - |
30 | | -- [Rate Limiting](https://github.com/openknowledge/workshop-api-design/tree/rate-limiting) |
31 | | -- [Backstage](https://github.com/openknowledge/workshop-api-design/tree/backstage) |
32 | | - |
33 | | -### API Operation |
34 | | - |
35 | | -- [Observability](https://github.com/openknowledge/workshop-api-design/tree/observability) |
36 | | - |
37 | | -### API Evolution |
38 | | - |
39 | | -- [Versioning](https://github.com/openknowledge/workshop-api-design/tree/versioning) |
| 29 | +Der Swagger-Editor kann über folgenden Link aufgerufen werden: |
| 30 | +[Swagger Editor](http://localhost:6060). |
0 commit comments