Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mdecker-mobilecomputing/maven_springboot_kfzunterscheidungszeichen

REST-API um Unterscheidungskennzeichen von deutschen KFZ-Kennzeichen abzufragen
https://github.com/mdecker-mobilecomputing/maven_springboot_kfzunterscheidungszeichen

docker example github-actions maven rest-api spring-boot

Last synced: 10 days ago
JSON representation

REST-API um Unterscheidungskennzeichen von deutschen KFZ-Kennzeichen abzufragen

Awesome Lists containing this project

README

        

# REST-API-Server für Abfrage Unterscheidungszeichen KFZ-Kennzeichen #


Dieses Repository enthält eine einfache Spring-Boot-Anwendung, die eine kleine REST-API zur Abfrage von
Unterscheidungszeichen von deutschen KFZ-Kennzeichen enthält (z.B. "BAD" für "Baden-Baden").

Nach Start der Anwendung (z.B. durch Skript `maven_start` im Wurzelverzeichnis des Repos) kann man lokal
unter http://localhost:8080 eine Dokumentationsseite abrufen, auf der Links zu möglichen REST-Anfragen enthalten sind.


**REST-Endpunkte:**
```
unterscheidungszeichen/v1/suche/
unterscheidungszeichen/v1/anzahl
```


**Beispiel-URLs (lokaler Zugriff mit Standard-Port):**

* http://localhost:8080/unterscheidungszeichen/v1/anzahl (siehe unten für Response)
* http://localhost:8080/unterscheidungszeichen/v1/suche/b
* http://localhost:8080/unterscheidungszeichen/v1/suche/ba
* http://localhost:8080/unterscheidungszeichen/v1/suche/bad (siehe unten für Response)
* http://localhost:8080/unterscheidungszeichen/v1/suche/badx (illegal, weil zu lang)
* http://localhost:8080/unterscheidungszeichen/v1/suche/y


JSON-Response für Abfrage der Anzahl:
```
{ "anzahl": 10 }
```


JSON-Response für Abfrage "bad":
```
{
"erfolgreich": true,
"fehlermeldung": "",
"unterscheidungszeichen": {
"kuerzel": "BAD",
"bedeutung": "Baden-Baden",
"kategorie": "Baden-Württemberg"
}
}
```


----

## License ##


See the [LICENSE file](LICENSE.md) for license rights and limitations (BSD 3-Clause License).