lug/matterbridge
10
0
Fork 2
Code Issues 4 Pull Requests Actions Packages Projects Releases Wiki Activity

Added mention of API and screenshot to README.

Browse Source
This commit is contained in:
Patrick Connolly
2018-11-05 17:07:55 +08:00
parent c97ecb2a7f
commit c9e3d46127
2 changed files with 6 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -62,7 +62,12 @@
* [API](https://github.com/42wim/matterbridge/wiki/Features#api)
### API
The API is very basic at the moment and rather undocumented.
The API is very basic at the moment. It uses the [Swagger/OpenAPI
specification](https://swagger.io/), and so will have documentation and
an interactive web interface accessible on your instance. To view it,
simply visit the top level root path.
![Screenshot of Swagger API web interface](docs/screenshot-swagger-api.png)
Used by at least 3 projects. Feel free to make a PR to add your project to this list.

BIN
docs/screenshot-swagger-api.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 82 KiB