From 904caeeeb292f56067a545a19a326f77e1cd9ec9 Mon Sep 17 00:00:00 2001
From: Colin Okay <okay@toyful.space>
Date: Tue, 8 Feb 2022 15:11:02 -0600
Subject: update readme about documentationg enerator; added example

---
 example/lazybones-test-docs.md | 69 ++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 69 insertions(+)
 create mode 100644 example/lazybones-test-docs.md

(limited to 'example/lazybones-test-docs.md')

diff --git a/example/lazybones-test-docs.md b/example/lazybones-test-docs.md
new file mode 100644
index 0000000..e7133f1
--- /dev/null
+++ b/example/lazybones-test-docs.md
@@ -0,0 +1,69 @@
+# Lazybones Demo App - v0.0.0
+
+Just an API that defines some endpoints. These
+  endpoints aren't meant to accomplish anything. merely to test out
+  the lazybones HTTP routing framework.
+
+## Endpoints
+
+### POST /hello/:who:
+*text/plain*
+
+Route Variables: 
+
+- WHO
+
+Authorization Required: 
+
+> Request is authorized if it contains the right TESTAPPSESSION
+>   cookie. Obtain such a cookie by posting to the /login endpoint.
+
+Post something to hello who
+
+### GET /hello/:who:
+*text/plain*
+
+Route Variables: 
+
+- WHO
+
+Just says hello to WHO
+
+### POST /login
+*text/plain*
+
+Dummy login endpoint for returning a session cookie. Always returns
+  the "true" and sends a set-cookie header, setting 'testappsession'
+  to 'coolsessionbro'.
+
+### GET /person/:person person-by-id:
+*application/json*
+
+Route Variables: 
+
+- PERSON: A Person Instance
+
+Returns a json representation of the person.
+
+### POST /search
+*text/plain*
+
+Authorization Required: 
+
+> Randomly decides that the request is authorized
+
+Echo the search parameters in a nice list, but also has a post-body
+
+### GET /search
+*text/plain*
+
+Echo the search parameters in a nice list.
+
+### GET /search/:category to-int:
+*text/plain*
+
+Route Variables: 
+
+- CATEGORY: An Integer
+
+Echo the search back, but in a specific category
\ No newline at end of file
-- 
cgit v1.2.3