openstack
/
monasca-api
Code Issues Proposed changes

Updated README

This commit is contained in:
Roland Hochmuth 2014-05-08 17:05:22 -06:00
parent c2cb0f0baa
commit 81bef5d66e
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -28,11 +28,13 @@ Requests flow through the following architectural layers from top to bottom:
## Documentation
When running mon-api the API docs along with the API test interface can be accessed via:
There are several forms of documentation for the Monitoring API.
[http://localhost:8080/swagger-ui/](http://localhost:8080/swagger-ui/)
* Overview: [docs/mon-api-overview.md](docs/mon-api-overview.md)
Note: the trailing "/" is necessary for the Swagger UI to work properly.
* API Specification: [docs/mon-api-spec.md](docs/mon-api-spec.md)
* swagger-ui: When running mon-api the API docs along with the API test interface can be accessed at, [http://localhost:8080/swagger-ui/](http://localhost:8080/swagger-ui/). Note: the trailing "/" is necessary for the Swagger UI to work properly.
# License