???? ??? ?? ? API(?????? ????? ?????)? ?? ? ????? ????? ????. ? API ???? ?? ???? ???? ?? API ??? ???? ?? ?? ?????. ?? API ??? ?? ??? ? ?? ??? ?? ??? ? ? ?? ?? ???? ??? Swagger???. ??? ?? ???? ThinkPHP6 ??????? ???? API ????? ?? ??? ???? API ??? ???? ??? ??? ? ????.

1. ?? ?? ?? ???? ??

?? ThinkPHP6 ????? "topthink/think-apidoc"?? API ?? ?? ?? ????? ???? ???. ???? ?? ????? ?? Composer ??? ??? ???? ??? ??? ? ????.

composer require topthink/think-apidoc

2. Write API ????? ??

??? ???? API ????? ?? ??? ??? ? ????. ThinkPHP6??? ???? ???? ??? ???? API ????? ??? ??? ? ????. ?:

/**
 * 獲取用戶信息
 *
 * @ApiTitle    (獲取用戶信息)
 * @ApiSummary  (通過用戶ID獲取用戶信息)
 * @ApiMethod   (GET)
 * @ApiRoute    (/user/:id)
 * @ApiParams   (name="id", type="integer", required=true, description="用戶ID")
 * @ApiReturn   ({"code": 200, "msg": "success", "data": {"id": 1, "name": "張三", "age": 18}})
 * @ApiHeaders  (name="Authorization", type="string", required=true, description="用戶授權(quán)Token")
 */
public function getUserInfo($id)
{
    // TODO: 獲取用戶信息的邏輯
}

? ????? API ?????? ???? ?? ? ?? ?? ??? ??????.

• @ApiTitle: ????? ??
• @ApiSummary: ????? ??
• @ApiMethod: ?? ???(GET, POST, PUT) ?)
• @ApiRoute: ????? ??(?: "/user/:id", ??? ":id"? ?? ????? ???)
• @ApiParams: ???? ??, ???? ??? ??? ????? ????, ?? ??
• @ApiReturn: ?? ? ?? ? ?? ? ??? ??? ????? ?? ?
• @ApiHeaders: ????? ?? ??(?: ?? ??)

? ??? ???? API? ???? ??? ? ????. ????? ?? ??.

3. API ?? ??

API ????? ??? ??? ? ThinkPHP6?? ???? ??? ??? ???? API ??? ??? ? ????. ???? ?? ?????? ?? ??? ?????.

php think apidoc --module api --path ./public/apidoc --type json

? ???? apido? ?? ??? ??? ?? ??? ??????(????? json ??? ???). ?? --module ????? "api"? ??????. ?? "api" ??? ?? API ??? ????? ?????. ?? ?? ??????? ??? ?? ??? ? ????.

? ??? ???? ??? ?? ???? ??? API ??? ?? ? ????. ? ???? API ?????? ?? ??? ?? ??? ? ??? ????? ????? ??? ? ????.

??:

?? ?????? ?? ?? ??? ???? ?? ???? ? ???? ??? ??? ? ? ?? ??? ???? ??? ????? ??? ?? ?????? ?

? ??? API ????? ?? ??? ?? ThinkPHP6? ???? ??? ??????? ?? ?????. ??? ??? PHP ??? ????? ?? ?? ??? ?????!