Skip to content

Commit 34e9ae8

Browse files
committed
Add exercise about API Design
1 parent dee4d28 commit 34e9ae8

File tree

2 files changed

+22
-53
lines changed

2 files changed

+22
-53
lines changed

README.md

Lines changed: 19 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -2,38 +2,29 @@
22

33
Herzlich willkommen zum Workshop API Design.
44

5-
## Übungen
5+
## Aufgabe: Design einer RESTful API
66

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.
814

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
1216

13-
### API Testing
17+
Bitte beschreiben Sie die API im OpenAPI-Format.
18+
Verwenden Sie dazu den Swagger-Editor
1419

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
1721

18-
### API Security
22+
Mit folgendem Befehl kann der Swagger-Editor gestartet werden:
23+
```
24+
docker compose up
25+
```
1926

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
2328

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).

docker-compose.yaml

Lines changed: 3 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,6 @@
11
services:
2-
customer-service:
3-
build: customer-service/
2+
openapi-editor:
3+
image: "swaggerapi/swagger-editor:v5.0.0-alpha.81-unprivileged"
44
ports:
5-
- "8181:8080"
6-
environment:
7-
- BILLING_SERVICE_URL=http://billing-service:8080
8-
- DELIVERY_SERVICE_URL=http://delivery-service:8080
5+
- "6060:8080"
96

10-
billing-service:
11-
build: billing-service/
12-
container_name: billing-service
13-
ports:
14-
- "8182:8080"
15-
16-
delivery-service:
17-
build: delivery-service/
18-
container_name: delivery-service
19-
ports:
20-
- "8183:8080"
21-
environment:
22-
- ADDRESS_VALIDATION_SERVICE_URL=http://address-validation-service:8080
23-
24-
address-validation-service:
25-
build: address-validation-service/
26-
container_name: address-validation_service
27-
ports:
28-
- "8184:8080"

0 commit comments

Comments
 (0)