1c21b8575b
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 |
||
|---|---|---|
| .. | ||
| asterisk_processor.py | ||
| do-not-edit.mustache | ||
| make_stasis_http_stubs.py | ||
| odict.py | ||
| README.txt | ||
| res_stasis_http_resource.c.mustache | ||
| rest_handler.mustache | ||
| stasis_http.make.mustache | ||
| stasis_http_resource.c.mustache | ||
| stasis_http_resource.h.mustache | ||
| swagger_model.py | ||
| transform.py | ||
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/