orthanc: OrthancFramework/Sources/RestApi/RestApi.cpp annotate

annotate OrthancFramework/Sources/RestApi/RestApi.cpp @ 4400:029366f95217

cppcheck

author	Sebastien Jodogne <s.jodogne@gmail.com>
date	Wed, 23 Dec 2020 12:30:56 +0100
parents	80fd140b12ba
children	354ea95b294a

rev	line source
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	1 /**
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2 * Orthanc - A Lightweight, RESTful DICOM Store
1900 b1291df2f780 2016 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1571 diff changeset	3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
1288 6e7e5ed91c2d upgrade to year 2015 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1113 diff changeset	4 * Department, University Hospital of Liege, Belgium
3640 94f4a18a79cc upgrade to year 2020 Sebastien Jodogne <s.jodogne@gmail.com> parents: 3401 diff changeset	5 * Copyright (C) 2017-2020 Osimis S.A., Belgium
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	6 *
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	7 * This program is free software: you can redistribute it and/or
4119 bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	8 * modify it under the terms of the GNU Lesser General Public License
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	9 * as published by the Free Software Foundation, either version 3 of
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	10 * the License, or (at your option) any later version.
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	11 *
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	12 * This program is distributed in the hope that it will be useful, but
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	13 * WITHOUT ANY WARRANTY; without even the implied warranty of
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
4119 bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	15 * Lesser General Public License for more details.
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	16 *
4119 bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	17 * You should have received a copy of the GNU Lesser General Public
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	18 * License along with this program. If not, see
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL Sebastien Jodogne <s.jodogne@gmail.com> parents: 4044 diff changeset	19 * <http://www.gnu.org/licenses/>.
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	20 **/
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	21
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	22
824 a811bdf8b8eb precompiled headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 689 diff changeset	23 #include "../PrecompiledHeaders.h"
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	24 #include "RestApi.h"
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	25
4399 80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	26 #include "../HttpServer/StringHttpOutput.h"
1486 f967bdf8534e refactoring to Logging.h Sebastien Jodogne <s.jodogne@gmail.com> parents: 1446 diff changeset	27 #include "../Logging.h"
4399 80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	28 #include "../OrthancException.h"
1486 f967bdf8534e refactoring to Logging.h Sebastien Jodogne <s.jodogne@gmail.com> parents: 1446 diff changeset	29
249 5694365ecb96 fixes for windows Sebastien Jodogne <s.jodogne@gmail.com> parents: 215 diff changeset	30 #include <stdlib.h> // To define "_exit()" under Windows
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	31 #include <stdio.h>
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	32
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	33 namespace Orthanc
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	34 {
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	35 namespace
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	36 {
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	37 // Anonymous namespace to avoid clashes between compilation modules
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	38 class HttpHandlerVisitor : public RestApiHierarchy::IVisitor
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	39 {
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	40 private:
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	41 RestApi& api_;
1046 00f9f36bcd94 on-the-fly conversion of JSON to XML according to HTTP Accept Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	42 RestApiOutput& output_;
1571 3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	43 RequestOrigin origin_;
3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	44 const char* remoteIp_;
3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	45 const char* username_;
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	46 HttpMethod method_;
4330 a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox Sebastien Jodogne <s.jodogne@gmail.com> parents: 4119 diff changeset	47 const HttpToolbox::Arguments& headers_;
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox Sebastien Jodogne <s.jodogne@gmail.com> parents: 4119 diff changeset	48 const HttpToolbox::Arguments& getArguments_;
3401 962e5f00744b cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3060 diff changeset	49 const void* bodyData_;
1446 8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body Sebastien Jodogne <s.jodogne@gmail.com> parents: 1441 diff changeset	50 size_t bodySize_;
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	51
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	52 public:
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	53 HttpHandlerVisitor(RestApi& api,
1046 00f9f36bcd94 on-the-fly conversion of JSON to XML according to HTTP Accept Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	54 RestApiOutput& output,
1571 3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	55 RequestOrigin origin,
3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	56 const char* remoteIp,
3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	57 const char* username,
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	58 HttpMethod method,
4330 a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox Sebastien Jodogne <s.jodogne@gmail.com> parents: 4119 diff changeset	59 const HttpToolbox::Arguments& headers,
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox Sebastien Jodogne <s.jodogne@gmail.com> parents: 4119 diff changeset	60 const HttpToolbox::Arguments& getArguments,
3401 962e5f00744b cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3060 diff changeset	61 const void* bodyData,
1446 8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body Sebastien Jodogne <s.jodogne@gmail.com> parents: 1441 diff changeset	62 size_t bodySize) :
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	63 api_(api),
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	64 output_(output),
1571 3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	65 origin_(origin),
3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	66 remoteIp_(remoteIp),
3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	67 username_(username),
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	68 method_(method),
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	69 headers_(headers),
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	70 getArguments_(getArguments),
1446 8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body Sebastien Jodogne <s.jodogne@gmail.com> parents: 1441 diff changeset	71 bodyData_(bodyData),
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body Sebastien Jodogne <s.jodogne@gmail.com> parents: 1441 diff changeset	72 bodySize_(bodySize)
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	73 {
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	74 }
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	75
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	76 virtual bool Visit(const RestApiHierarchy::Resource& resource,
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	77 const UriComponents& uri,
4399 80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	78 bool hasTrailing,
4330 a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox Sebastien Jodogne <s.jodogne@gmail.com> parents: 4119 diff changeset	79 const HttpToolbox::Arguments& components,
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	80 const UriComponents& trailing)
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	81 {
4400 029366f95217 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4399 diff changeset	82 if (resource.HasHandler(method_))
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	83 {
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	84 switch (method_)
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	85 {
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	86 case HttpMethod_Get:
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	87 {
1571 3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	88 RestApiGetCall call(output_, api_, origin_, remoteIp_, username_,
3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	89 headers_, components, trailing, uri, getArguments_);
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	90 resource.Handle(call);
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	91 return true;
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	92 }
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	93
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	94 case HttpMethod_Post:
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	95 {
1571 3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	96 RestApiPostCall call(output_, api_, origin_, remoteIp_, username_,
3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	97 headers_, components, trailing, uri, bodyData_, bodySize_);
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	98 resource.Handle(call);
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	99 return true;
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	100 }
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	101
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	102 case HttpMethod_Delete:
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	103 {
1571 3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	104 RestApiDeleteCall call(output_, api_, origin_, remoteIp_, username_,
3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	105 headers_, components, trailing, uri);
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	106 resource.Handle(call);
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	107 return true;
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	108 }
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	109
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	110 case HttpMethod_Put:
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	111 {
1571 3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	112 RestApiPutCall call(output_, api_, origin_, remoteIp_, username_,
3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	113 headers_, components, trailing, uri, bodyData_, bodySize_);
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	114 resource.Handle(call);
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	115 return true;
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	116 }
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	117
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	118 default:
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	119 return false;
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	120 }
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	121 }
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	122
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	123 return false;
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	124 }
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	125 };
4399 80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	126
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	127
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	128
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	129 class OpenApiVisitor : public RestApiHierarchy::IVisitor
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	130 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	131 private:
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	132 RestApi& restApi_;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	133 Json::Value paths_;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	134
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	135 public:
4400 029366f95217 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4399 diff changeset	136 explicit OpenApiVisitor(RestApi& restApi) :
4399 80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	137 restApi_(restApi)
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	138 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	139 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	140
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	141 virtual bool Visit(const RestApiHierarchy::Resource& resource,
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	142 const UriComponents& uri,
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	143 bool hasTrailing,
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	144 const HttpToolbox::Arguments& components,
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	145 const UriComponents& trailing)
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	146 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	147 const std::string path = Toolbox::FlattenUri(uri);
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	148
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	149 if (paths_.isMember(path))
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	150 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	151 throw OrthancException(ErrorCode_InternalError);
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	152 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	153
4400 029366f95217 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4399 diff changeset	154 if (resource.HasHandler(HttpMethod_Get))
4399 80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	155 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	156 StringHttpOutput o1;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	157 HttpOutput o2(o1, false);
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	158 RestApiOutput o3(o2, HttpMethod_Get);
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	159 RestApiGetCall call(o3, restApi_, RequestOrigin_Documentation, "" /* remote IP */,
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	160 "" /* username /, HttpToolbox::Arguments() / HTTP headers */,
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	161 HttpToolbox::Arguments() /* URI components */,
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	162 UriComponents() /* trailing */,
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	163 uri, HttpToolbox::Arguments() /* GET arguments */);
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	164
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	165 bool ok = false;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	166 Json::Value v;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	167
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	168 try
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	169 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	170 ok = (resource.Handle(call) &&
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	171 call.GetDocumentation().FormatOpenApi(v));
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	172 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	173 catch (OrthancException&)
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	174 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	175 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	176 catch (boost::bad_lexical_cast&)
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	177 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	178 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	179
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	180 if (ok)
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	181 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	182 paths_[path]["get"] = v;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	183 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	184 else
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	185 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	186 LOG(WARNING) << "Ignoring URI without API documentation: GET " << path;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	187 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	188 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	189
4400 029366f95217 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4399 diff changeset	190 if (resource.HasHandler(HttpMethod_Post))
4399 80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	191 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	192 StringHttpOutput o1;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	193 HttpOutput o2(o1, false);
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	194 RestApiOutput o3(o2, HttpMethod_Post);
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	195 RestApiPostCall call(o3, restApi_, RequestOrigin_Documentation, "" /* remote IP */,
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	196 "" /* username /, HttpToolbox::Arguments() / HTTP headers */,
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	197 HttpToolbox::Arguments() /* URI components */,
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	198 UriComponents() /* trailing /, uri, NULL / body /, 0 / body size */);
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	199
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	200 bool ok = false;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	201 Json::Value v;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	202
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	203 try
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	204 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	205 ok = (resource.Handle(call) &&
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	206 call.GetDocumentation().FormatOpenApi(v));
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	207 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	208 catch (OrthancException&)
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	209 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	210 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	211 catch (boost::bad_lexical_cast&)
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	212 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	213 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	214
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	215 if (ok)
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	216 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	217 paths_[path]["post"] = v;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	218 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	219 else
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	220 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	221 LOG(WARNING) << "Ignoring URI without API documentation: POST " << path;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	222 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	223 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	224
4400 029366f95217 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4399 diff changeset	225 if (resource.HasHandler(HttpMethod_Delete))
4399 80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	226 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	227 StringHttpOutput o1;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	228 HttpOutput o2(o1, false);
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	229 RestApiOutput o3(o2, HttpMethod_Delete);
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	230 RestApiDeleteCall call(o3, restApi_, RequestOrigin_Documentation, "" /* remote IP */,
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	231 "" /* username /, HttpToolbox::Arguments() / HTTP headers */,
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	232 HttpToolbox::Arguments() /* URI components */,
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	233 UriComponents() /* trailing */, uri);
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	234
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	235 bool ok = false;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	236 Json::Value v;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	237
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	238 try
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	239 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	240 ok = (resource.Handle(call) &&
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	241 call.GetDocumentation().FormatOpenApi(v));
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	242 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	243 catch (OrthancException&)
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	244 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	245 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	246 catch (boost::bad_lexical_cast&)
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	247 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	248 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	249
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	250 if (ok)
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	251 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	252 paths_[path]["delete"] = v;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	253 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	254 else
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	255 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	256 LOG(WARNING) << "Ignoring URI without API documentation: DELETE " << path;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	257 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	258 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	259
4400 029366f95217 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 4399 diff changeset	260 if (resource.HasHandler(HttpMethod_Put))
4399 80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	261 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	262 StringHttpOutput o1;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	263 HttpOutput o2(o1, false);
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	264 RestApiOutput o3(o2, HttpMethod_Put);
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	265 RestApiPutCall call(o3, restApi_, RequestOrigin_Documentation, "" /* remote IP */,
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	266 "" /* username /, HttpToolbox::Arguments() / HTTP headers */,
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	267 HttpToolbox::Arguments() /* URI components */,
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	268 UriComponents() /* trailing /, uri, NULL / body /, 0 / body size */);
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	269
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	270 bool ok = false;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	271 Json::Value v;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	272
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	273 try
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	274 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	275 ok = (resource.Handle(call) &&
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	276 call.GetDocumentation().FormatOpenApi(v));
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	277 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	278 catch (OrthancException&)
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	279 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	280 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	281 catch (boost::bad_lexical_cast&)
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	282 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	283 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	284
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	285 if (ok)
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	286 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	287 paths_[path]["put"] = v;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	288 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	289 else
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	290 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	291 LOG(WARNING) << "Ignoring URI without API documentation: PUT " << path;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	292 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	293 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	294
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	295 return true;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	296 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	297
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	298
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	299 const Json::Value& GetPaths() const
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	300 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	301 return paths_;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	302 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	303 };
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	304 }
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	305
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	306
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	307
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	308 static void AddMethod(std::string& target,
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	309 const std::string& method)
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	310 {
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	311 if (target.size() > 0)
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	312 target += "," + method;
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	313 else
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	314 target = method;
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	315 }
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	316
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	317 static std::string MethodsToString(const std::set<HttpMethod>& methods)
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	318 {
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	319 std::string s;
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	320
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	321 if (methods.find(HttpMethod_Get) != methods.end())
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	322 {
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	323 AddMethod(s, "GET");
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	324 }
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	325
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	326 if (methods.find(HttpMethod_Post) != methods.end())
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	327 {
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	328 AddMethod(s, "POST");
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	329 }
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	330
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	331 if (methods.find(HttpMethod_Put) != methods.end())
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	332 {
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	333 AddMethod(s, "PUT");
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	334 }
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	335
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	336 if (methods.find(HttpMethod_Delete) != methods.end())
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	337 {
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	338 AddMethod(s, "DELETE");
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	339 }
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	340
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	341 return s;
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	342 }
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	343
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	344
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	345
4399 80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	346 bool RestApi::CreateChunkedRequestReader(std::unique_ptr<IChunkedRequestReader>& target,
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	347 RequestOrigin origin,
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	348 const char* remoteIp,
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	349 const char* username,
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	350 HttpMethod method,
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	351 const UriComponents& uri,
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	352 const HttpToolbox::Arguments& headers)
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	353 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	354 return false;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	355 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	356
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	357
895 7e8cde5905fd allow superposition of REST handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 824 diff changeset	358 bool RestApi::Handle(HttpOutput& output,
1571 3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	359 RequestOrigin origin,
3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	360 const char* remoteIp,
3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	361 const char* username,
473 c9a5d72f8481 changing the namespace of HTTP enumerations Sebastien Jodogne <s.jodogne@gmail.com> parents: 416 diff changeset	362 HttpMethod method,
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	363 const UriComponents& uri,
4330 a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox Sebastien Jodogne <s.jodogne@gmail.com> parents: 4119 diff changeset	364 const HttpToolbox::Arguments& headers,
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox Sebastien Jodogne <s.jodogne@gmail.com> parents: 4119 diff changeset	365 const HttpToolbox::GetArguments& getArguments,
3401 962e5f00744b cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 3060 diff changeset	366 const void* bodyData,
1446 8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body Sebastien Jodogne <s.jodogne@gmail.com> parents: 1441 diff changeset	367 size_t bodySize)
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	368 {
1368 b22ba8c5edbe query retrieve Sebastien Jodogne <s.jodogne@gmail.com> parents: 1363 diff changeset	369 RestApiOutput wrappedOutput(output, method);
1046 00f9f36bcd94 on-the-fly conversion of JSON to XML according to HTTP Accept Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	370
2136 dd609a99d39a uniformization of the macro naming Sebastien Jodogne <s.jodogne@gmail.com> parents: 1900 diff changeset	371 #if ORTHANC_ENABLE_PUGIXML == 1
1046 00f9f36bcd94 on-the-fly conversion of JSON to XML according to HTTP Accept Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	372 {
1511 7962563129c9 starting support of deflate/gzip content types Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	373 // Look if the client wishes XML answers instead of JSON
7962563129c9 starting support of deflate/gzip content types Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	374 // http://www.w3.org/Protocols/HTTP/HTRQ_Headers.html#z3
4330 a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox Sebastien Jodogne <s.jodogne@gmail.com> parents: 4119 diff changeset	375 HttpToolbox::Arguments::const_iterator it = headers.find("accept");
1511 7962563129c9 starting support of deflate/gzip content types Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	376 if (it != headers.end())
1046 00f9f36bcd94 on-the-fly conversion of JSON to XML according to HTTP Accept Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	377 {
1511 7962563129c9 starting support of deflate/gzip content types Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	378 std::vector<std::string> accepted;
7962563129c9 starting support of deflate/gzip content types Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	379 Toolbox::TokenizeString(accepted, it->second, ';');
7962563129c9 starting support of deflate/gzip content types Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	380 for (size_t i = 0; i < accepted.size(); i++)
1046 00f9f36bcd94 on-the-fly conversion of JSON to XML according to HTTP Accept Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	381 {
2905 ae20fccdd867 refactoring mime types Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	382 if (accepted[i] == MIME_XML)
1511 7962563129c9 starting support of deflate/gzip content types Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	383 {
7962563129c9 starting support of deflate/gzip content types Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	384 wrappedOutput.SetConvertJsonToXml(true);
7962563129c9 starting support of deflate/gzip content types Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	385 }
1046 00f9f36bcd94 on-the-fly conversion of JSON to XML according to HTTP Accept Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	386
2905 ae20fccdd867 refactoring mime types Sebastien Jodogne <s.jodogne@gmail.com> parents: 2447 diff changeset	387 if (accepted[i] == MIME_JSON)
1511 7962563129c9 starting support of deflate/gzip content types Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	388 {
7962563129c9 starting support of deflate/gzip content types Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	389 wrappedOutput.SetConvertJsonToXml(false);
7962563129c9 starting support of deflate/gzip content types Sebastien Jodogne <s.jodogne@gmail.com> parents: 1486 diff changeset	390 }
1046 00f9f36bcd94 on-the-fly conversion of JSON to XML according to HTTP Accept Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	391 }
00f9f36bcd94 on-the-fly conversion of JSON to XML according to HTTP Accept Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	392 }
00f9f36bcd94 on-the-fly conversion of JSON to XML according to HTTP Accept Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	393 }
00f9f36bcd94 on-the-fly conversion of JSON to XML according to HTTP Accept Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	394 #endif
00f9f36bcd94 on-the-fly conversion of JSON to XML according to HTTP Accept Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	395
4330 a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox Sebastien Jodogne <s.jodogne@gmail.com> parents: 4119 diff changeset	396 HttpToolbox::Arguments compiled;
1441 f3672356c121 refactoring: IHttpHandler and HttpToolbox Sebastien Jodogne <s.jodogne@gmail.com> parents: 1368 diff changeset	397 HttpToolbox::CompileGetArguments(compiled, getArguments);
1363 feaf2840917c Plugins now receive duplicated GET arguments in their REST callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	398
1571 3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	399 HttpHandlerVisitor visitor(*this, wrappedOutput, origin, remoteIp, username,
3232f1c995a5 provide the origin of the requests to HTTP handlers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1517 diff changeset	400 method, headers, compiled, bodyData, bodySize);
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	401
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	402 if (root_.LookupResource(uri, visitor))
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 895 diff changeset	403 {
1113 ba5c0908600c Refactoring of HttpOutput ("Content-Length" header is now always sent) Sebastien Jodogne <s.jodogne@gmail.com> parents: 1063 diff changeset	404 wrappedOutput.Finalize();
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	405 return true;
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 895 diff changeset	406 }
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 895 diff changeset	407
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	408 std::set<HttpMethod> methods;
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	409 root_.GetAcceptedMethods(methods, uri);
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	410
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	411 if (methods.empty())
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	412 {
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	413 return false; // This URI is not served by this REST API
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	414 }
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	415 else
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	416 {
477 6f8ae46ed90e moves Sebastien Jodogne <s.jodogne@gmail.com> parents: 473 diff changeset	417 LOG(INFO) << "REST method " << EnumerationToString(method)
416 1188cb0ddaa5 http method faking Sebastien Jodogne <s.jodogne@gmail.com> parents: 398 diff changeset	418 << " not allowed on: " << Toolbox::FlattenUri(uri);
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	419
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 980 diff changeset	420 output.SendMethodNotAllowed(MethodsToString(methods));
980 f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	421
f1ff2a2f06cd use RestApiHierarchy inside RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: 977 diff changeset	422 return true;
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	423 }
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	424 }
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	425
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	426 void RestApi::Register(const std::string& path,
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 824 diff changeset	427 RestApiGetCall::Handler handler)
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	428 {
977 2a9e08136860 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 976 diff changeset	429 root_.Register(path, handler);
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	430 }
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	431
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	432 void RestApi::Register(const std::string& path,
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 824 diff changeset	433 RestApiPutCall::Handler handler)
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	434 {
977 2a9e08136860 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 976 diff changeset	435 root_.Register(path, handler);
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	436 }
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	437
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	438 void RestApi::Register(const std::string& path,
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 824 diff changeset	439 RestApiPostCall::Handler handler)
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	440 {
977 2a9e08136860 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 976 diff changeset	441 root_.Register(path, handler);
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	442 }
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	443
9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	444 void RestApi::Register(const std::string& path,
974 83622b0f544c refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 824 diff changeset	445 RestApiDeleteCall::Handler handler)
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	446 {
977 2a9e08136860 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 976 diff changeset	447 root_.Register(path, handler);
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	448 }
1063 0332e6e8c679 Fix automated generation of the list of resource children in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1046 diff changeset	449
0332e6e8c679 Fix automated generation of the list of resource children in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1046 diff changeset	450 void RestApi::AutoListChildren(RestApiGetCall& call)
4399 80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	451 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	452 call.GetDocumentation()
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	453 .SetTag("Other")
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	454 .SetSummary("List of operations")
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	455 .SetDescription("List the available operations under URI: " + call.FlattenUri())
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	456 .AddAnswerType(MimeType_Json, "List of the available operations");
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	457
1063 0332e6e8c679 Fix automated generation of the list of resource children in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1046 diff changeset	458 RestApi& context = call.GetContext();
0332e6e8c679 Fix automated generation of the list of resource children in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1046 diff changeset	459
0332e6e8c679 Fix automated generation of the list of resource children in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1046 diff changeset	460 Json::Value directory;
0332e6e8c679 Fix automated generation of the list of resource children in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1046 diff changeset	461 if (context.root_.GetDirectory(directory, call.GetFullUri()))
0332e6e8c679 Fix automated generation of the list of resource children in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1046 diff changeset	462 {
4399 80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	463 if (call.IsDocumentation())
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	464 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	465 call.GetDocumentation().SetSample(directory);
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	466 }
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	467 else
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	468 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	469 call.GetOutput().AnswerJson(directory);
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	470 }
1063 0332e6e8c679 Fix automated generation of the list of resource children in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1046 diff changeset	471 }
0332e6e8c679 Fix automated generation of the list of resource children in the REST API Sebastien Jodogne <s.jodogne@gmail.com> parents: 1046 diff changeset	472 }
4399 80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	473
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	474
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	475 void RestApi::GenerateOpenApiDocumentation(Json::Value& target)
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	476 {
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	477 OpenApiVisitor visitor(*this);
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	478
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	479 UriComponents root;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	480 root_.ExploreAllResources(visitor, root);
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	481
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	482 target = Json::objectValue;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	483
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	484 target["info"]["version"] = ORTHANC_VERSION;
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	485 target["info"]["title"] = "Orthanc";
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	486
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	487 target["openapi"] = "3.0.0";
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	488
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	489 target["servers"].append(Json::objectValue);
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	490 target["servers"][0]["url"] = "https://demo.orthanc-server.com/";
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	491
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	492 target["paths"] = visitor.GetPaths();
80fd140b12ba New command-line option: "--openapi" to write the OpenAPI documentation of the REST API to a file Sebastien Jodogne <s.jodogne@gmail.com> parents: 4330 diff changeset	493 }
209 9960642f0f45 abstraction of RestApi Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	494 }

Mercurial > hg > orthanc

annotate OrthancFramework/Sources/RestApi/RestApi.cpp @ 4400:029366f95217