Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

A project to make OpenStack API's self documententing.

Project description

A project to make OpenStack API’s self documententing.

Features

  • Migrates WADL source to Swagger files
  • Provides display of RST plus Swagger JSON files in a web browser

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 output 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
conversion_files_valid/<service-version>.json -- valid Swagger files

Other API documentation Tools

Other Useful Tools

Project details


Release history Release notifications

This version
History Node

0.2.0

History Node

0.1.0

History Node

0.0.1.dev136

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
fairy_slipper-0.2.0-py2-none-any.whl (73.1 kB) Copy SHA256 hash SHA256 Wheel py2 Mar 11, 2016
fairy-slipper-0.2.0.tar.gz (88.2 kB) Copy SHA256 hash SHA256 Source None Mar 11, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page