wbec icon indicating copy to clipboard operation
wbec copied to clipboard

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

Open jb-io opened this issue 7 months ago • 0 comments

Tried to collect all API information from various places:

  • https://github.com/steff393/wbec/blob/master/README.md
  • https://github.com/steff393/wbec/blob/master/src/webServer.cpp
  • https://github.com/steff393/wbec/wiki/Webserver-sitemap

Created a machine readable api documentation accodring to standards. Human Readable Version can be generated on swagger.io

Links before accepting Merge Request:

  • Editor: https://editor.swagger.io/?url=https://raw.githubusercontent.com/jb-io/wbec/add-swagger-documentation/api.swagger.yaml
  • Viewer: https://petstore.swagger.io/?url=https://raw.githubusercontent.com/jb-io/wbec/add-swagger-documentation/api.swagger.yaml

After Merge Request:

  • Editor: https://editor.swagger.io/?url=https://raw.githubusercontent.com/steff393/wbec/master/api.swagger.yaml
  • Viewer: https://petstore.swagger.io/?url=https://raw.githubusercontent.com/steff393/wbec/master/api.swagger.yaml

jb-io avatar May 29 '25 08:05 jb-io