Skip to content
Snippets Groups Projects
  • David M. Lee's avatar
    1c21b857
    This patch adds a RESTful HTTP interface to Asterisk. · 1c21b857
    David M. Lee authored
    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
    1c21b857
    History
    This patch adds a RESTful HTTP interface to Asterisk.
    David M. Lee authored
    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