Automatic HTTP API documentation for TiddlyWeb
Project description
A serialization which provides documentation of the request methods and serializations for all the resources available from the current TiddlyWeb instance.
That is: for any existing resource if you get it as text/x-tiddlyweb-docs this code will automatically generate documentation about this thing.
So, for example http://example.com/bags/foo/tiddlers.x-doc will list the serializations and HTTP methods available at that URI.
The motivation for this is to cause lack-of-documentation shame.
Install by adding tiddlywebplugins.docs to system_plugins in tiddlywebconfig.py.
Copyright 2011 Chris Dent <cdent@peermore.com> BSD License
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file tiddlywebplugins.docs-0.4.tar.gz
.
File metadata
- Download URL: tiddlywebplugins.docs-0.4.tar.gz
- Upload date:
- Size: 7.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | cae7a9439aaf69316724abc76e91b4b9ac9120d91ec8ffb8b391e9d60a3c6c31 |
|
MD5 | 60539a8c62798d708602b6ec0875a8aa |
|
BLAKE2b-256 | 958344c5fc71bddca2f5963f040df22966e34755923a8ed068aabe6eaa8c1781 |