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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 81d23b534bfbc241e95657e4c07bef35057f1ff8b1ee162f4cf08a917c430701 |
|
MD5 | 4ab7626b2340e9cc6e5f87fc9720f041 |
|
BLAKE2b-256 | ecc89d78359e70d45de36ec9b7c726cddbca69b146f5c8262c58a06b7c9d21c1 |