mirrors/oatpp
1
0
Fork 0
mirror of https://gitee.com/zyjblog/oatpp.git synced 2025-01-03 05:22:24 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Leonid Stryzhevskyi 2020-05-23 03:34:01 +03:00 committed by GitHub
parent 1c0aea3f88
commit a8ceacbced
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -50,7 +50,7 @@ For more info see [Api Controller](https://oatpp.io/docs/components/api-controll
```cpp ```cpp
ENDPOINT("PUT", "/users/{userId}", putUser, ENDPOINT("PUT", "/users/{userId}", putUser,
PATH(Int64, userId), PATH(Int64, userId),
BODY_DTO(UserDto, userDto)) BODY_DTO(Object<UserDto>, userDto))
{ {
userDto->id = userId; userDto->id = userId;
return createDtoResponse(Status::CODE_200, m_database->updateUser(userDto)); return createDtoResponse(Status::CODE_200, m_database->updateUser(userDto));
@ -65,7 +65,7 @@ For more info see [Api Controller / CORS](https://oatpp.io/docs/components/api-c
ADD_CORS(putUser) ADD_CORS(putUser)
ENDPOINT("PUT", "/users/{userId}", putUser, ENDPOINT("PUT", "/users/{userId}", putUser,
PATH(Int64, userId), PATH(Int64, userId),
BODY_DTO(UserDto, userDto)) BODY_DTO(Object<UserDto>, userDto))
{ {
userDto->id = userId; userDto->id = userId;
return createDtoResponse(Status::CODE_200, m_database->updateUser(userDto)); return createDtoResponse(Status::CODE_200, m_database->updateUser(userDto));
@ -82,7 +82,7 @@ using namespace oatpp::web::server::handler;
ENDPOINT("PUT", "/users/{userId}", putUser, ENDPOINT("PUT", "/users/{userId}", putUser,
AUTHORIZATION(std::shared_ptr<DefaultBasicAuthorizationObject>, authObject), AUTHORIZATION(std::shared_ptr<DefaultBasicAuthorizationObject>, authObject),
PATH(Int64, userId), PATH(Int64, userId),
BODY_DTO(UserDto, userDto)) BODY_DTO(Object<UserDto>, userDto))
{ {
OATPP_ASSERT_HTTP(authObject->userId == "Ivan" && authObject->password == "admin", Status::CODE_401, "Unauthorized"); OATPP_ASSERT_HTTP(authObject->userId == "Ivan" && authObject->password == "admin", Status::CODE_401, "Unauthorized");
userDto->id = userId; userDto->id = userId;
@ -100,15 +100,15 @@ For more info see [Endpoint Annotation And API Documentation](https://oatpp.io/d
ENDPOINT_INFO(putUser) { ENDPOINT_INFO(putUser) {
// general // general
info->summary = "Update User by userId"; info->summary = "Update User by userId";
info->addConsumes<UserDto>("application/json"); info->addConsumes<Object<UserDto>>("application/json");
info->addResponse<UserDto>(Status::CODE_200, "application/json"); info->addResponse<Object<UserDto>>(Status::CODE_200, "application/json");
info->addResponse<String>(Status::CODE_404, "text/plain"); info->addResponse<String>(Status::CODE_404, "text/plain");
// params specific // params specific
info->pathParams["userId"].description = "User Identifier"; info->pathParams["userId"].description = "User Identifier";
} }
ENDPOINT("PUT", "/users/{userId}", putUser, ENDPOINT("PUT", "/users/{userId}", putUser,
PATH(Int64, userId), PATH(Int64, userId),
BODY_DTO(UserDto, userDto)) BODY_DTO(Object<UserDto>, userDto))
{ {
userDto->id = userId; userDto->id = userId;
return createDtoResponse(Status::CODE_200, m_database->updateUser(userDto)); return createDtoResponse(Status::CODE_200, m_database->updateUser(userDto));
@ -137,7 +137,7 @@ public:
```cpp ```cpp
auto response = userService->getUserById(id); auto response = userService->getUserById(id);
auto user = response->readBodyToDto<dto::UserDto>(objectMapper); auto user = response->readBodyToDto<oatpp::Object<UserDto>>(objectMapper);
``` ```
### Object Mapping ### Object Mapping
@ -147,9 +147,9 @@ For more info see [Data Transfer Object (DTO)](https://oatpp.io/docs/components/
#### Declare DTO #### Declare DTO
```cpp ```cpp
class UserDto : public oatpp::data::mapping::type::Object { class UserDto : public oatpp::DTO {
DTO_INIT(UserDto, Object) DTO_INIT(UserDto, DTO)
DTO_FIELD(Int64, id); DTO_FIELD(Int64, id);
DTO_FIELD(String, name); DTO_FIELD(String, name);