Skip to content

Add swagger API documentation as a central standardized place for all api endpoints #163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Add swagger API documentation as a central standardized place for all api endpoints #163

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
76e932b
Create api.swagger.yaml
jb-io Sep 16, 2024
d3a86e2
Update api.swagger.yaml
jb-io Sep 16, 2024
7947046
Update README.md
jb-io Sep 16, 2024
3dc5c1f
Update swagger descriptions from Readme example
jb-io May 29, 2025
d905e73
Update swagger descriptions according to webServer.cpp
jb-io May 29, 2025
230247f
Minimal useablility fixes
jb-io May 29, 2025
6548149
Change Readme so swagger link will work on origin project.
jb-io May 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ Ziel des Projekts ist es, eine WLAN-Schnittstelle zu entwickeln um zusätzliche

![GitHub all releases](https://img.shields.io/github/downloads/steff393/wbec/total?color=blue&style=flat-square)

## API
Die Vollständige API Dokumentation befindet sich in der Datei [api.swagger.yaml](./api.swagger.yaml).
Eine Formatierte Version ist unter [petstore.swagger.io](https://petstore.swagger.io/?url=https://raw.githubusercontent.com/steff393/wbec/master/api.swagger.yaml) verfügbar.

## Funktionen
- Anbindung an openWB, EVCC, Solaranzeige
- MQTT-Kommunikation mit openWB und EVCC (ideal für mehrere Ladestationen)
Expand Down
Loading