Created
April 24, 2014 15:29
-
-
Save fuzzyalej/11258873 to your computer and use it in GitHub Desktop.
CL DSL for generation API documentation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
(generate-api-documentation | |
:base "http://api.test.com" | |
:title "API Documentaition for TEST" | |
:author "fuzzyalej" | |
(with-endpoint "/book" | |
:method "GET" | |
:description "This will fetch a book from the database" | |
(parameters | |
(id | |
:type "String" | |
:required t | |
:format "5") | |
(name | |
:type "String" | |
:required nil | |
:format "Book Name")) | |
(returns | |
:200 "All went ok" | |
:400 "Something went wrong") | |
(example | |
:title "Normal example" | |
:status 200 | |
:format "json" | |
:data "{'name':'Book Title'}"))) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment