This release is a pre-release and may not be stable for production use.
A project to make OpenStack API’s self documententing.
Free software: Apache license
Documentation: :(
Features
Migrate from WADL to Swagger-ish
Generate docs from Python source code
Run server to display API docs
Development
First run the migrate script to initially migrate the content from wadl:
./migrate.sh
This script will checkout the current version of the documentation.
To run the webserver use:
./run_server.sh
A Pecan based webserver will then listen on http://127.0.0.1:8080
AngularJS
To develop the AngularJS component, it’s easiest if you use the grunt webserver:
grunt
You will still need to run the Fairy-Slipper webserver, but this will enable auto reloading if you visit the port http://127.0.0.1:9000
Directory Structure (Future)
Current documentation layout:
api-doc/ -- the root of the documentation api-doc/index.json -- the index file that lists all the files that are included in the API doc. api-doc/<service>/<version>.rst api-doc/<service>/<version>/<request_schema>.json api-doc/<service>/<version>/<response_schema>_<status_code>.json api-doc/<service>/<version>/examples/<request>_req.json api-doc/<service>/<version>/examples/<response>_resp_<status_code>.json
Other Swagger UIs
Taken from https://github.com/swagger-api/swagger-spec/wiki/Sites-and-Services
