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
Hashes for tiddlywebplugins.docs-0.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 507f3bfef1a2e29be7aae2f4253b974effa88b4cde3b6908ee9f1704f9cba10b |
|
MD5 | 03508f1fb1d1a9301de3cdae207aae50 |
|
BLAKE2b-256 | b5d21038b216382a92667bb0d40e483b1f7cbf731ce5e3d0762fdac16030b1eb |