README.md 667 Bytes
Newer Older
Jonas-Ian Kuche's avatar
Jonas-Ian Kuche committed
1
2
# Feedback APP API-Dokumention

Jonas-Ian Kuche's avatar
Jonas-Ian Kuche committed
3
## Selber bauen
Jonas-Ian Kuche's avatar
Jonas-Ian Kuche committed
4

Jonas-Ian Kuche's avatar
Jonas-Ian Kuche committed
5
Lokal kann die API-Dokumentation mithilfe des [OpenApi Generator Docker-Container](https://hub.docker.com/r/openapitools/openapi-generator-cli) gebaut werden:
Jonas-Ian Kuche's avatar
Jonas-Ian Kuche committed
6
7

```bash
Jonas-Ian Kuche's avatar
Jonas-Ian Kuche committed
8
docker run --rm -v `pwd`:/api-docs --workdir /api-docs openapitools/openapi-generator-cli  generate -i openapi.yaml -g html -o docs 
Jonas-Ian Kuche's avatar
Jonas-Ian Kuche committed
9
10
```

Jonas-Ian Kuche's avatar
Jonas-Ian Kuche committed
11
oder mithilfe der [OpenApi Generator .jar](https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/4.3.1/openapi-generator-cli-4.3.1.jar):
Jonas-Ian Kuche's avatar
Jonas-Ian Kuche committed
12
13

```bash
Jonas-Ian Kuche's avatar
Jonas-Ian Kuche committed
14
java -jar <Pfad zur JAR> generate -i openapi.yaml -g html -o docs
Jonas-Ian Kuche's avatar
Jonas-Ian Kuche committed
15
16
```

Jonas-Ian Kuche's avatar
Jonas-Ian Kuche committed
17
Die resultierende HTML Datei befindet sich in beiden fällen im `docs` Ordner.