Hawkin
/
arangodb
mirror of https://gitee.com/bigwinds/arangodb
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Doc - reference swagger on a prominent place (#5731)

This commit is contained in:
Wilfried Goesgens 2018-07-02 15:33:23 +02:00 committed by sleto-it
parent 7aaeab50fb
commit 8c586a1a91
2 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Documentation/Books/HTTP/README.md
View File

@ -6,5 +6,16 @@ for API developers. As a user or administrator of ArangoDB you should
not need the information provided herein.
In general, as a user of ArangoDB you will use one of the language
[drivers](https://www.arangodb.com/drivers/).
[drivers](https://www.arangodb.com/arangodb-drivers/).
**Interactive Swagger documentation**
Please note that your ArangoDB comes with an interactive version of
this docmunentation using [Swagger](https://swagger.io):
![accessing the documentation via swagger](assets/swagger_serverapi_overview.png)
We also have a blog post explaining [how to work with the Swagger API
](https://www.arangodb.com/2018/03/using-arangodb-swaggerio-interactive-api-documentation/).

BIN
Documentation/Books/HTTP/assets/swagger_serverapi_overview.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 96 KiB