mirror of
https://github.com/asterisk/asterisk.git
synced 2025-09-03 19:28:53 +00:00
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
43 lines
973 B
JSON
43 lines
973 B
JSON
{
|
|
"_copyright": "Copyright (C) 2012 - 2013, Digium, Inc.",
|
|
"_author": "David M. Lee, II <dlee@digium.com>",
|
|
"_svn_revision": "$Revision$",
|
|
"apiVersion": "0.0.1",
|
|
"swaggerVersion": "1.1",
|
|
"basePath": "http://localhost:8088/stasis",
|
|
"apis": [
|
|
{
|
|
"path": "/api-docs/asterisk.{format}",
|
|
"description": "Asterisk resources"
|
|
},
|
|
{
|
|
"path": "/api-docs/endpoints.{format}",
|
|
"description": "Endpoint resources"
|
|
},
|
|
{
|
|
"path": "/api-docs/channels.{format}",
|
|
"description": "Channel resources"
|
|
},
|
|
{
|
|
"path": "/api-docs/bridges.{format}",
|
|
"description": "Bridge resources"
|
|
},
|
|
{
|
|
"path": "/api-docs/recordings.{format}",
|
|
"description": "Recording resources"
|
|
},
|
|
{
|
|
"path": "/api-docs/sounds.{format}",
|
|
"description": "Sound resources"
|
|
},
|
|
{
|
|
"path": "/api-docs/playback.{format}",
|
|
"description": "Playback control resources"
|
|
},
|
|
{
|
|
"path": "/api-docs/events.{format}",
|
|
"description": "WebSocket resource"
|
|
}
|
|
]
|
|
}
|