fairy-slipper
A project to make OpenStack API’s self documententing.
Free software: Apache license
Documentation: doc/source directory
Source: https://git.openstack.org/cgit/openstack/fairy-slipper
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 Swagger UIs
Taken from https://github.com/swagger-api/swagger-spec/wiki/Sites-and-Services
Other API documentation Tools
Alternative Clients
Other Useful Tools
2 maintainers
Metadata
2 maintainers
Release files for fairy-slipper 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| fairy-slipper-0.2.0.tar.gz | 88.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| fairy_slipper-0.2.0-py2-none-any.whl | Python 2 | none | any | Details |
Total release size: 161.2 kB
Release files / fairy-slipper-0.2.0.tar.gz
| Download URL | fairy-slipper-0.2.0.tar.gz |
|---|---|
| Size | 88.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
52b17b0178c4ba12880ad5167a70d4edd628898e4a4f38c7f11fb24e22cfa9fa
|
|
BLAKE2b-256 checksum How to use checksums |
598f5015924e08e272ae07551ca69dd1aaa699b209c429343e942dfdf6a7b397
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Release files / fairy_slipper-0.2.0-py2-none-any.whl
| Download URL | fairy_slipper-0.2.0-py2-none-any.whl |
|---|---|
| Size | 73.1 kB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
9b3d85e6711f1a5a77a1bb973e7bc638e394d83b8ccf1f29a284259ab42b981a
|
|
BLAKE2b-256 checksum How to use checksums |
bccee06c3359dd475d8d5d0e9fddd4c5e789847c0c7a113a7e9e7095d265f27d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
