Skip to main content

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

tiddlywebplugins.docs-0.5.tar.gz (7.1 kB view details)

Uploaded Source

File details

Details for the file tiddlywebplugins.docs-0.5.tar.gz.

File metadata

File hashes

Hashes for tiddlywebplugins.docs-0.5.tar.gz
Algorithm Hash digest
SHA256 d7efd2797a69165fb3fef86dd8ce4348b26afbd87506cee8ba705d789be6ae82
MD5 a4c5552962db3d4d07719aba5cc3075b
BLAKE2b-256 ed778eca93f54ecec887cc32a1a0c9d26aa78ebe7f5475221b70da3682d7d6e4

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page