Skip to content

Commit 9ffa938

Browse files
authored
Merge pull request #94 from aronkankel/main
Readme um Codegenerierung und Informationsquellen ergänzt
2 parents a75ca84 + 5a61513 commit 9ffa938

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,31 @@ In diesem Repository werden die Beschreibung der API zur HS Auftragsbearbeitung
44
# Elements UI API
55
Die Schnittstellenbeschreibung kann auch in der Elements UI API direkt als GitHub-Page angezeigt werden unter folgender URL:
66
https://hamburger-software.github.io/ab-api/
7+
8+
# Code-Generierung
9+
Für die Code-Generierung aus der YAML-Datei kann z.B. der OpenApi Generator verwendet werden (https://openapi-generator.tech/docs/usage/).
10+
Es werden diverse Programmiersprachen unterstützt.
11+
12+
Die Code-Generierung kann mit dem Kommandozeilen-Tool "openapi-generator-cli" erfolgen. Für C#-Client-Code kann das z.B. so aussehen:
13+
```bat
14+
java -jar openapi-generator-cli-7.3.0.jar generate -i AB-API.yaml -g csharp --generate-alias-as-model --model-name-suffix Model -c config.json --http-user-agent MySolution -o C:\TEMP\Hs.Ab.RestApi
15+
```
16+
17+
Sinnvoll ist die Verwendung eines eigenen Namespaces. Dieser kann über eine Config-Datei (z.B. config.json) angegeben werden, z.B.:
18+
### config.json
19+
```json
20+
{
21+
"packageName": "Hs.Ab.RestApi.Generated",
22+
"targetFramework": "net48"
23+
}
24+
```
25+
26+
Außerdem sollte der HTTP-User-Agent gesetzt werden. Das ist über die Kommandozeile möglich:
27+
```bat
28+
--http-user-agent MySolution
29+
```
30+
31+
# Weitere Informationen
32+
Weitere Informationen für Lösungsersteller gibt es
33+
- in der Hilfe der Auftragsbearbeitung im Kapitel "Anleitung & Wissen / Datenaustausch / API (Webservice) / Anwendungswissen"
34+
- in der Datei "ab_api_webservice.pdf" im Unterverzeichnis "Hilfe_Pdfs" des Programmverzeichnisses der installierten Auftragsbearbeitung (z.B. C:\Program Files (x86)\Hs\Ab)

0 commit comments

Comments
 (0)