2 This file is part of GNUnet
3 Copyright (C) 2010-2015 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
22 * @author Martin Schanzenbach
25 * API for helper library to parse/create REST
27 * @defgroup rest REST library
28 * Helper library to parse/create REST
31 #ifndef GNUNET_REST_LIB_H
32 #define GNUNET_REST_LIB_H
34 #include "gnunet_util_lib.h"
35 #include <microhttpd.h>
37 #define GNUNET_REST_HANDLER_END { NULL, NULL, NULL }
39 struct GNUNET_REST_RequestHandle
42 * Map of url parameters
44 struct GNUNET_CONTAINER_MultiHashMap *url_param_map;
49 struct GNUNET_CONTAINER_MultiHashMap *header_param_map;
52 * The HTTP method as MHD value (see microhttpd.h)
72 struct GNUNET_REST_RequestHandlerError
78 struct GNUNET_REST_RequestHandler
81 * Http method to handle
88 const char *namespace;
93 void (*proc) (struct GNUNET_REST_RequestHandle *handle,
100 * Iterator called on obtained result for a REST result.
103 * @param resp the response
104 * @param status status code (HTTP)
106 typedef void (*GNUNET_REST_ResultProcessor) (void *cls,
107 struct MHD_Response *resp,
111 * Check if namespace is in URL.
113 * @param url URL to check
114 * @param namespace namespace to check against
115 * @return GNUNET_YES if namespace matches
118 GNUNET_REST_namespace_match (const char *url, const char *namespace);
121 * Create REST MHD response
124 * @return MHD response
127 GNUNET_REST_create_response (const char *data);
131 GNUNET_REST_handle_request (struct GNUNET_REST_RequestHandle *conn,
132 const struct GNUNET_REST_RequestHandler *handlers,
133 struct GNUNET_REST_RequestHandlerError *err,
139 /** @} */ /* end of group */