]> git.ipfire.org Git - thirdparty/asterisk.git/commit
This patch adds a RESTful HTTP interface to Asterisk.
authorDavid M. Lee <dlee@digium.com>
Mon, 22 Apr 2013 14:58:53 +0000 (14:58 +0000)
committerDavid M. Lee <dlee@digium.com>
Mon, 22 Apr 2013 14:58:53 +0000 (14:58 +0000)
commit1c21b8575bfd70b98b1102fd3dd09fc0bc335e14
tree9a6ef6074e545ad2768bc1994e1a233fc1443729
parent1871017cc6bd2e2ce7c638eeb6813e982377a521
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
63 files changed:
Makefile
configs/stasis_http.conf.sample [new file with mode: 0644]
include/asterisk/http.h
include/asterisk/json.h
include/asterisk/stasis_app.h
include/asterisk/stasis_http.h [new file with mode: 0644]
include/asterisk/strings.h
main/http.c
main/json.c
res/Makefile
res/res_stasis.c
res/res_stasis_http.c [new file with mode: 0644]
res/res_stasis_http.exports.in [new file with mode: 0644]
res/res_stasis_http_asterisk.c [new file with mode: 0644]
res/res_stasis_http_bridges.c [new file with mode: 0644]
res/res_stasis_http_channels.c [new file with mode: 0644]
res/res_stasis_http_endpoints.c [new file with mode: 0644]
res/res_stasis_http_events.c [new file with mode: 0644]
res/res_stasis_http_playback.c [new file with mode: 0644]
res/res_stasis_http_recordings.c [new file with mode: 0644]
res/res_stasis_http_sounds.c [new file with mode: 0644]
res/stasis_http.make [new file with mode: 0644]
res/stasis_http/resource_asterisk.c [new file with mode: 0644]
res/stasis_http/resource_asterisk.h [new file with mode: 0644]
res/stasis_http/resource_bridges.c [new file with mode: 0644]
res/stasis_http/resource_bridges.h [new file with mode: 0644]
res/stasis_http/resource_channels.c [new file with mode: 0644]
res/stasis_http/resource_channels.h [new file with mode: 0644]
res/stasis_http/resource_endpoints.c [new file with mode: 0644]
res/stasis_http/resource_endpoints.h [new file with mode: 0644]
res/stasis_http/resource_events.c [new file with mode: 0644]
res/stasis_http/resource_events.h [new file with mode: 0644]
res/stasis_http/resource_playback.c [new file with mode: 0644]
res/stasis_http/resource_playback.h [new file with mode: 0644]
res/stasis_http/resource_recordings.c [new file with mode: 0644]
res/stasis_http/resource_recordings.h [new file with mode: 0644]
res/stasis_http/resource_sounds.c [new file with mode: 0644]
res/stasis_http/resource_sounds.h [new file with mode: 0644]
rest-api-templates/README.txt [new file with mode: 0644]
rest-api-templates/asterisk_processor.py [new file with mode: 0644]
rest-api-templates/do-not-edit.mustache [new file with mode: 0644]
rest-api-templates/make_stasis_http_stubs.py [new file with mode: 0755]
rest-api-templates/odict.py [new file with mode: 0644]
rest-api-templates/res_stasis_http_resource.c.mustache [new file with mode: 0644]
rest-api-templates/rest_handler.mustache [new file with mode: 0644]
rest-api-templates/stasis_http.make.mustache [new file with mode: 0644]
rest-api-templates/stasis_http_resource.c.mustache [new file with mode: 0644]
rest-api-templates/stasis_http_resource.h.mustache [new file with mode: 0644]
rest-api-templates/swagger_model.py [new file with mode: 0644]
rest-api-templates/transform.py [new file with mode: 0644]
rest-api/README.txt [new file with mode: 0644]
rest-api/api-docs/asterisk.json [new file with mode: 0644]
rest-api/api-docs/bridges.json [new file with mode: 0644]
rest-api/api-docs/channels.json [new file with mode: 0644]
rest-api/api-docs/endpoints.json [new file with mode: 0644]
rest-api/api-docs/events.json [new file with mode: 0644]
rest-api/api-docs/playback.json [new file with mode: 0644]
rest-api/api-docs/recordings.json [new file with mode: 0644]
rest-api/api-docs/sounds.json [new file with mode: 0644]
rest-api/resources.json [new file with mode: 0644]
tests/test_stasis.c
tests/test_stasis_http.c [new file with mode: 0644]
tests/test_strings.c