diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 25 |
1 files changed, 22 insertions, 3 deletions
@@ -65,9 +65,6 @@ The following is quick example showing a few things that `lazybones` can do. (lzb:set-canned-response *server* 403 'custom-403 "text/plain" ) (lzb:set-canned-response *server* 500 #p"/path/to/500error.txt" "text/plain" ) - - - ;; PPROVISION-APP makes an app. You can supply an optional name, a symbol. ;; In lieu of a supplied name, the name of the package is used as the app's name. (lzb:provision-app () @@ -169,6 +166,28 @@ The following is quick example showing a few things that `lazybones` can do. ``` +## Generate Documentation + +Generate a markdown file documenting the endpoints of an APP / API like so: + +``` + +;; continuing from above +(in-package :lazybones-test) + +(alexandria:write-string-into-file + (lzb:generate-app-documentation (lzb:app)) + #p"lazybones-test-docs.md" + :if-exists :supersede) + +``` + +Then use your favorite markdown processor to generate HTML or whatever +your preferred documentation distribution format is. See +`example/lazybones-test-docs.md` for an example of the documentation +generator output. + + ## Backends **WARNING** Users can mostly ignore thissection. The API for alternate backends is in |