mirror of
https://github.com/asterisk/asterisk.git
synced 2025-10-03 11:11:05 +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
128 lines
3.6 KiB
C
128 lines
3.6 KiB
C
/*
|
|
* Asterisk -- An open source telephony toolkit.
|
|
*
|
|
* Copyright (C) 2012 - 2013, Digium, Inc.
|
|
*
|
|
* David M. Lee, II <dlee@digium.com>
|
|
*
|
|
* See http://www.asterisk.org for more information about
|
|
* the Asterisk project. Please do not directly contact
|
|
* any of the maintainers of this project for assistance;
|
|
* the project provides a web site, mailing lists and IRC
|
|
* channels for your use.
|
|
*
|
|
* This program is free software, distributed under the terms of
|
|
* the GNU General Public License Version 2. See the LICENSE file
|
|
* at the top of the source tree.
|
|
*/
|
|
|
|
/*
|
|
* !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
* !!!!! DO NOT EDIT !!!!!
|
|
* !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
* This file is generated by a mustache template. Please see the original
|
|
* template in rest-api-templates/res_stasis_http_resource.c.mustache
|
|
*/
|
|
|
|
/*! \file
|
|
*
|
|
* \brief Endpoint resources
|
|
*
|
|
* \author David M. Lee, II <dlee@digium.com>
|
|
*/
|
|
|
|
/*** MODULEINFO
|
|
<depend type="module">res_stasis_http</depend>
|
|
<support_level>core</support_level>
|
|
***/
|
|
|
|
#include "asterisk.h"
|
|
|
|
ASTERISK_FILE_VERSION(__FILE__, "$Revision$")
|
|
|
|
#include "asterisk/module.h"
|
|
#include "stasis_http/resource_endpoints.h"
|
|
|
|
/*!
|
|
* \brief Parameter parsing callback for /endpoints.
|
|
* \param get_params GET parameters in the HTTP request.
|
|
* \param path_vars Path variables extracted from the request.
|
|
* \param headers HTTP headers.
|
|
* \param[out] response Response to the HTTP request.
|
|
*/
|
|
static void stasis_http_get_endpoints_cb(
|
|
struct ast_variable *get_params, struct ast_variable *path_vars,
|
|
struct ast_variable *headers, struct stasis_http_response *response)
|
|
{
|
|
struct ast_get_endpoints_args args = {};
|
|
struct ast_variable *i;
|
|
|
|
for (i = get_params; i; i = i->next) {
|
|
if (strcmp(i->name, "withType") == 0) {
|
|
args.with_type = (i->value);
|
|
} else
|
|
{}
|
|
}
|
|
stasis_http_get_endpoints(headers, &args, response);
|
|
}
|
|
/*!
|
|
* \brief Parameter parsing callback for /endpoints/{endpointId}.
|
|
* \param get_params GET parameters in the HTTP request.
|
|
* \param path_vars Path variables extracted from the request.
|
|
* \param headers HTTP headers.
|
|
* \param[out] response Response to the HTTP request.
|
|
*/
|
|
static void stasis_http_get_endpoint_cb(
|
|
struct ast_variable *get_params, struct ast_variable *path_vars,
|
|
struct ast_variable *headers, struct stasis_http_response *response)
|
|
{
|
|
struct ast_get_endpoint_args args = {};
|
|
struct ast_variable *i;
|
|
|
|
for (i = path_vars; i; i = i->next) {
|
|
if (strcmp(i->name, "endpointId") == 0) {
|
|
args.endpoint_id = (i->value);
|
|
} else
|
|
{}
|
|
}
|
|
stasis_http_get_endpoint(headers, &args, response);
|
|
}
|
|
|
|
/*! \brief REST handler for /api-docs/endpoints.{format} */
|
|
static struct stasis_rest_handlers endpoints_endpointId = {
|
|
.path_segment = "endpointId",
|
|
.is_wildcard = 1,
|
|
.callbacks = {
|
|
[AST_HTTP_GET] = stasis_http_get_endpoint_cb,
|
|
},
|
|
.num_children = 0,
|
|
.children = { }
|
|
};
|
|
/*! \brief REST handler for /api-docs/endpoints.{format} */
|
|
static struct stasis_rest_handlers endpoints = {
|
|
.path_segment = "endpoints",
|
|
.callbacks = {
|
|
[AST_HTTP_GET] = stasis_http_get_endpoints_cb,
|
|
},
|
|
.num_children = 1,
|
|
.children = { &endpoints_endpointId, }
|
|
};
|
|
|
|
static int load_module(void)
|
|
{
|
|
return stasis_http_add_handler(&endpoints);
|
|
}
|
|
|
|
static int unload_module(void)
|
|
{
|
|
stasis_http_remove_handler(&endpoints);
|
|
return 0;
|
|
}
|
|
|
|
AST_MODULE_INFO(ASTERISK_GPL_KEY, AST_MODFLAG_DEFAULT,
|
|
"RESTful API module - Endpoint resources",
|
|
.load = load_module,
|
|
.unload = unload_module,
|
|
.nonoptreq = "res_stasis_http",
|
|
);
|