diff options
| author | David M. Lee <dlee@digium.com> | 2013-04-22 14:58:53 +0000 |
|---|---|---|
| committer | David M. Lee <dlee@digium.com> | 2013-04-22 14:58:53 +0000 |
| commit | 1c21b8575bfd70b98b1102fd3dd09fc0bc335e14 (patch) | |
| tree | 9a6ef6074e545ad2768bc1994e1a233fc1443729 /rest-api-templates/README.txt | |
| parent | 1871017cc6bd2e2ce7c638eeb6813e982377a521 (diff) | |
This patch adds a RESTful HTTP interface to Asterisk.
The API itself is documented using Swagger, a lightweight mechanism for
documenting RESTful API's using JSON. This allows us to use swagger-ui
to provide executable documentation for the API, generate client
bindings in different languages, and generate a lot of the boilerplate
code for implementing the RESTful bindings. The API docs live in the
rest-api/ directory.
The RESTful bindings are generated from the Swagger API docs using a set
of Mustache templates. The code generator is written in Python, and
uses Pystache. Pystache has no dependencies, and be installed easily
using pip. Code generation code lives in rest-api-templates/.
The generated code reduces a lot of boilerplate when it comes to
handling HTTP requests. It also helps us have greater consistency in the
REST API.
(closes issue ASTERISK-20891)
Review: https://reviewboard.asterisk.org/r/2376/
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@386232 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'rest-api-templates/README.txt')
| -rw-r--r-- | rest-api-templates/README.txt | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/rest-api-templates/README.txt b/rest-api-templates/README.txt new file mode 100644 index 000000000..e927ad768 --- /dev/null +++ b/rest-api-templates/README.txt @@ -0,0 +1,15 @@ +This directory contains templates and template processing code for generating +HTTP bindings for the RESTful API's. + +The RESTful API's are declared using [Swagger][swagger]. While Swagger provides +a [code generating toolkit][swagger-codegen], it requires Java to run, which +would be an unusual dependency to require for Asterisk developers. + +This code generator is similar, but written in Python. Templates are processed +by using [pystache][pystache], which is a fairly simply Python implementation of +[mustache][mustache]. + + [swagger]: https://github.com/wordnik/swagger-core/wiki + [swagger-codegen]: https://github.com/wordnik/swagger-codegen + [pystache]: https://github.com/defunkt/pystache + [mustache]: http://mustache.github.io/ |