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/rest_handler.mustache | |
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/rest_handler.mustache')
-rw-r--r-- | rest-api-templates/rest_handler.mustache | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/rest-api-templates/rest_handler.mustache b/rest-api-templates/rest_handler.mustache new file mode 100644 index 000000000..a7dfc60e8 --- /dev/null +++ b/rest-api-templates/rest_handler.mustache @@ -0,0 +1,38 @@ +{{! -*- C -*- + * Asterisk -- An open source telephony toolkit. + * + * Copyright (C) 2013, Digium, Inc. + * + * David M. Lee, II <dlee@digium.com> + * + * See http://www.asterisk.org for more information about + * the Asterisk project. Please do not directly contact + * any of the maintainers of this project for assistance; + * the project provides a web site, mailing lists and IRC + * channels for your use. + * + * This program is free software, distributed under the terms of + * the GNU General Public License Version 2. See the LICENSE file + * at the top of the source tree. +}} +{{! + * Recursive partial template to render a rest_handler. Used in + * res_stasis_http_resource.c.mustache. +}} +{{#children}} +{{> rest_handler}} +{{/children}} +/*! \brief REST handler for {{path}} */ +static struct stasis_rest_handlers {{full_name}} = { + .path_segment = "{{name}}", +{{#is_wildcard}} + .is_wildcard = 1, +{{/is_wildcard}} + .callbacks = { +{{#operations}} + [{{c_http_method}}] = stasis_http_{{c_nickname}}_cb, +{{/operations}} + }, + .num_children = {{num_children}}, + .children = { {{#children}}&{{full_name}},{{/children}} } +}; |