mirror/oatpp
2
0
Fork 0
mirror of https://github.com/oatpp/oatpp.git synced 2025-02-23 17:40:28 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #369 from oatpp/better_endpoint_info

Browse Source 
EndpointInfo: Add example field for parameters.
This commit is contained in:
Leonid Stryzhevskyi 2021-01-03 04:57:34 +02:00 committed by GitHub
commit 2ec763b814
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 27 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/oatpp/codegen/api_controller/base_define.hpp
View File

@ -209,11 +209,18 @@ const auto& OATPP_MACRO_FIRSTARG PARAM_LIST = __request->readBodyToString();
#define OATPP_MACRO_API_CONTROLLER_BODY_STRING_INFO(TYPE, PARAM_LIST) \
info->body.name = OATPP_MACRO_FIRSTARG_STR PARAM_LIST; \
info->body.type = oatpp::data::mapping::type::__class::String::getType();
info->body.required = true; \
info->body.type = oatpp::data::mapping::type::__class::String::getType(); \
if(getDefaultObjectMapper()) { \
info->bodyContentType = getDefaultObjectMapper()->getInfo().http_content_type; \
}
// BODY_DTO MACRO // ------------------------------------------------------
#define OATPP_MACRO_API_CONTROLLER_BODY_DTO(TYPE, PARAM_LIST) \
if(!getDefaultObjectMapper()) { \
return ApiController::handleError(Status::CODE_500, "ObjectMapper was NOT set. Can't deserialize the request body."); \
} \
const auto& OATPP_MACRO_FIRSTARG PARAM_LIST = \
__request->readBodyToDto<TYPE>(getDefaultObjectMapper().get()); \
if(!OATPP_MACRO_FIRSTARG PARAM_LIST) { \
@ -224,7 +231,11 @@ if(!OATPP_MACRO_FIRSTARG PARAM_LIST) { \
#define OATPP_MACRO_API_CONTROLLER_BODY_DTO_INFO(TYPE, PARAM_LIST) \
info->body.name = OATPP_MACRO_FIRSTARG_STR PARAM_LIST; \
info->body.type = TYPE::Class::getType();
info->body.required = true; \
info->body.type = TYPE::Class::getType(); \
if(getDefaultObjectMapper()) { \
info->bodyContentType = getDefaultObjectMapper()->getInfo().http_content_type; \
}
// FOR EACH // ------------------------------------------------------

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

@ -67,7 +67,8 @@ public:
oatpp::Boolean required = true;
oatpp::Boolean deprecated = false;
oatpp::Boolean allowEmptyValue;
oatpp::Any example;
};
/**
@ -111,10 +112,11 @@ public:
/**
* Hints about the response (content-type, schema, description, ...)
*/
struct ResponseHints {
struct ContentHints {
oatpp::String contentType;
oatpp::data::mapping::type::Type* schema;
oatpp::String description;
oatpp::Any example;
};
public:
@ -183,7 +185,7 @@ public:
/**
* Consumes.
*/
std::list<ResponseHints> consumes;
std::list<ContentHints> consumes;
/**
* Security Requirements
@ -209,7 +211,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, ResponseHints> responses;
std::unordered_map<oatpp::web::protocol::http::Status, ContentHints> responses;
oatpp::String toString();
@ -219,8 +221,9 @@ public:
* @param contentType
*/
template<class Wrapper>
void addConsumes(const oatpp::String& contentType, const oatpp::String& description = oatpp::String()) {
ContentHints& addConsumes(const oatpp::String& contentType, const oatpp::String& description = oatpp::String()) {
consumes.push_back({contentType, Wrapper::Class::getType(), description});
return consumes.back();
}
/**
@ -231,8 +234,12 @@ public:
* @param responseDescription
*/
template<class Wrapper>
void addResponse(const oatpp::web::protocol::http::Status& status, const oatpp::String& contentType, const oatpp::String& responseDescription = oatpp::String()) {
responses[status] = {contentType, Wrapper::Class::getType(), responseDescription.get() == nullptr ? status.description : responseDescription};
ContentHints& addResponse(const oatpp::web::protocol::http::Status& status, const oatpp::String& contentType, const oatpp::String& responseDescription = oatpp::String()) {
auto& hint = responses[status];
hint.contentType = contentType;
hint.description = responseDescription.get() == nullptr ? status.description : responseDescription;
hint.schema = Wrapper::Class::getType();
return hint;
}
/**