uniadmin-apidoc接口文檔查看工具 UI
uniadmin-apidoc是無侵入的Swagger3/OpenApi3.0接口文檔查看工具UI。引用即可生效,無需自己配置路由,無需自己部署swagger-ui到public目錄。 插件為你做好了一切,基于ThinkPHP6的無侵入OpenApi UI界面,基于swagger-bootstrap-ui制作。
軟件架構(gòu)
基于ThinPHP6的ServiceProvider與Swagger-Bootstrap-UI
安裝教程
composer require-dev zircote/swagger-php
composer require-dev uniadmin/uniadmin-apidoc dev-master
寫一個(gè)文檔
在一個(gè)控制器比如app/controller/User.php里寫一個(gè)標(biāo)準(zhǔn)的接開文檔如下
/**
* 用戶登錄
*
* @OA\POST(
* tags={"核心模塊"},
* summary="用戶登錄",
* description="支持賬號(hào)密碼、手機(jī)號(hào)、郵箱登錄",
* path="/core/user/login",
* @OA\Response(response="200",description="獲取成功"),
* @OA\Parameter(
* name="account",in="query",required=true,description="用戶名",
* @OA\Schema(type="string")
* ),
* @OA\Parameter(
* name="password",in="query",required=true,description="用戶密碼",
* @OA\Schema(type="string")
* )
* )
*
* @param \think\Request $request
* @return \think\Response
* @author jry <[email protected]>
*/
public function login(Request $request)
{
}
使用說明
訪問 {域名:端口}/doc
評(píng)論
圖片
表情
