Question

我在Symfony4应用程序中使用API平台来公开我的资源。这是一个很好的框架，但是默认情况下它会迫使您将所有业务逻辑都放在前端，因为它公开了所有实体而不是业务对象。

我不喜欢这样，我更喜欢将我的业务逻辑放在后端。

我需要创建用户，但是有不同类型的用户。所以我在后端创建了一个UserFactory。因此，前端只需要推送业务对象，后端就可以处理所有事情。

前端不能将用户对象直接保留在数据库中。这是后端的作用

在本教程之后，请使用DTO进行阅读： https://api-platform.com/docs/core/dto/#how-to-use-a-dto-for-reading

我正在尝试发布相同的内容。而且有效。这是我的控制器代码：

/**
 * @Route(
 *     path="/create/model",
 *     name="create-model",
 *     methods={"POST"},
 *     defaults={
 *          "_api_respond"=true,
 *          "_api_normalization_context"={"api_sub_level"=true},
 *          "_api_swagger_context"={
 *              "tags"={"User"},
 *              "summary"="Create a user Model",
 *              "parameters"={
 *                  
 *              },
 *              "responses"={
 *                  "201"={
 *                      "description"="User Model created",
 *                      "schema"={
 *                          "type"="object",
 *                          "properties"={
 *                              "firstName"={"type"="string"},
 *                              "lastName"={"type"="string"},
 *                              "email"={"type"="string"},
 *                          }
 *                      }
 *                  }
 *              }
 *          }
 *     }
 * )
 * @param Request $request
 * @return \App\Entity\User
 * @throws \App\Exception\ClassNotFoundException
 * @throws \App\Exception\InvalidUserException
 */
public function createModel(Request $request)
{
    $model = $this->serializer->deserialize($request->getContent(), Model::class, 'json');
    $user = $this->userFactory->create($model);
    $this->userRepository->save($user);

    return $user;
}

效果很好，但是我希望我的新资源可以在Swagger UI中使用，因此我可以通过POST方法直接在Web界面中创建新资源。

为此，我认为我需要在_api_swagger_context中完成参数部分。但是我没有找到任何有关此的文档。

我该怎么做？

Answer 1

在这里找到答案：https://github.com/api-platform/docs/issues/666

您可以像这样填充参数：

 "parameters" = {
     {
        "name" = "data",
        "in" = "body",
        "required" = "true",
        "schema" = {
            "type" = "object",
            "properties" = {
                 "firstName"={"type"="string"},
                 "lastName"={"type"="string"},
                 "email" = {"type" = "string" }
             }
         },
     },
 },

更多有关swagger参数的文档：https://swagger.io/docs/specification/2-0/describing-parameters/

API平台-如何使用DTO进行发布？

1 个答案: