首页 > 解决方案 > 如何从 Laravel 发现请求主体以生成 OpenAPI 规范?

问题描述

OpenAPI 规范支持请求正文(主要用于 POST 请求等):

    paths:
      /pets:
        post:
          summary: Add a new pet
          requestBody:
            description: Optional description in *Markdown*
            required: true
            content:
              application/json:
                schema:
                  $ref: '#/components/schemas/Pet'
          responses:
            '201':
              description: Created

Laravel 请求方法通常看起来像这样:

public function create(JsonRequest $request): UserResource
{
    $data = $request->json()->all();
    $user = User::create($data);
    $user->save();
    return new UserResource($user);
}

有没有办法从中发现请求正文(它可能包含/需要哪些字段,字段具有哪些类型)以便能够将其包含在 API 规范中?

标签: laravelrestapiopenapi

解决方案


推荐阅读