mirror of
https://github.com/asterisk/asterisk.git
synced 2025-09-29 18:19:30 +00:00
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
This commit is contained in:
68
rest-api/api-docs/endpoints.json
Normal file
68
rest-api/api-docs/endpoints.json
Normal file
@@ -0,0 +1,68 @@
|
||||
{
|
||||
"_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",
|
||||
"resourcePath": "/api-docs/endpoints.{format}",
|
||||
"apis": [
|
||||
{
|
||||
"path": "/endpoints",
|
||||
"description": "Asterisk endpoints",
|
||||
"operations": [
|
||||
{
|
||||
"httpMethod": "GET",
|
||||
"summary": "List available endoints.",
|
||||
"nickname": "getEndpoints",
|
||||
"responseClass": "List[Endpoint]",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "withType",
|
||||
"description": "Filter endpoints by type (sip,iax2,dhadi,...)",
|
||||
"paramType": "query",
|
||||
"required": false,
|
||||
"allowMultiple": true,
|
||||
"dataType": "string"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"path": "/endpoints/{endpointId}",
|
||||
"description": "Single endpoint",
|
||||
"operations": [
|
||||
{
|
||||
"httpMethod": "GET",
|
||||
"summary": "Details for an endpoint.",
|
||||
"nickname": "getEndpoint",
|
||||
"responseClass": "Endpoint",
|
||||
"parameters": [
|
||||
{
|
||||
"name": "endpointId",
|
||||
"description": "ID of the endpoint",
|
||||
"paramType": "path",
|
||||
"dataType": "string"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"models": {
|
||||
"Endpoint": {
|
||||
"id": "Endpoint",
|
||||
"properties": {
|
||||
"technology": {
|
||||
"type": "string",
|
||||
"required": true
|
||||
},
|
||||
"name": {
|
||||
"type": "string",
|
||||
"required": true
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
Reference in New Issue
Block a user