mirror/oatpp
2
0
Fork 0
mirror of https://github.com/oatpp/oatpp.git synced 2025-01-30 16:59:30 +08:00
Code Issues Packages Projects Releases Wiki Activity

Response Description (Issue #212)

Browse Source
This commit is contained in:
Benedikt-Alexander Mokroß 2020-04-02 13:55:11 +02:00
parent eabe287550
commit 328519e6c1
2 changed files with 11 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/oatpp/web/server/api/Endpoint.hpp
View File

@ -109,11 +109,12 @@ public:
};
/**
* Info about content type and schema
* Hints about the response (content-type, schema, description, ...)
*/
struct ContentTypeAndSchema {
struct ResponseHints {
oatpp::String contentType;
oatpp::data::mapping::type::Type* schema;
oatpp::String description;
};
public:
@ -182,7 +183,7 @@ public:
/**
* Consumes.
*/
std::list<ContentTypeAndSchema> consumes;
std::list<ResponseHints> consumes;
/**
* Security Requirements
@ -208,7 +209,7 @@ public:
* ResponseCode to {ContentType, Type} mapping.
* Example responses[Status::CODE_200] = {"application/json", MyDto::ObjectWrapper::Class::getType()};
*/
std::unordered_map<oatpp::web::protocol::http::Status, ContentTypeAndSchema> responses;
std::unordered_map<oatpp::web::protocol::http::Status, ResponseHints> responses;
oatpp::String toString();
@ -227,10 +228,11 @@ public:
* @tparam T
* @param status
* @param contentType
* @param responseDescription
*/
template<class T>
void addResponse(const oatpp::web::protocol::http::Status& status, const oatpp::String& contentType) {
responses[status] = {contentType, T::Class::getType()};
void addResponse(const oatpp::web::protocol::http::Status& status, const oatpp::String& contentType, const oatpp::String& responseDescription = oatpp::String()) {
responses[status] = {contentType, T::Class::getType(), responseDescription.get() == nullptr ? status.description : responseDescription};
}
/**

4
test/oatpp/web/server/api/ApiControllerTest.cpp
View File

@ -47,7 +47,7 @@ public:
ENDPOINT_INFO(root) {
info->summary = "root_summary";
info->addResponse<String>(Status::CODE_200, "text/plain");
info->addResponse<String>(Status::CODE_200, "text/plain", "test1-success");
info->addResponse<String>(Status::CODE_404, "text/plain");
}
ENDPOINT("GET", "/", root) {
@ -98,9 +98,11 @@ void ApiControllerTest::onRun() {
auto r200 = endpoint->info()->responses[Status::CODE_200];
OATPP_ASSERT(r200.contentType == "text/plain");
OATPP_ASSERT(r200.schema == oatpp::String::Class::getType());
OATPP_ASSERT(r200.description == "test1-success");
auto r404 = endpoint->info()->responses[Status::CODE_404];
OATPP_ASSERT(r404.contentType == "text/plain");
OATPP_ASSERT(r404.description == "Not Found");
OATPP_ASSERT(r404.schema == oatpp::String::Class::getType());
auto response = controller.root();