{"id":13411481,"url":"https://github.com/zhuzixian520/yii2-api-doc","last_synced_at":"2025-10-25T17:30:35.584Z","repository":{"id":57091180,"uuid":"361443688","full_name":"zhuzixian520/yii2-api-doc","owner":"zhuzixian520","description":"Generate online api document by code annotation for yii2 easily","archived":false,"fork":false,"pushed_at":"2021-04-27T01:45:59.000Z","size":58,"stargazers_count":16,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-09-30T23:49:07.536Z","etag":null,"topics":["api","yii2-extension"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zhuzixian520.png","metadata":{"files":{"readme":"README-CN.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-04-25T13:59:47.000Z","updated_at":"2021-12-15T09:06:07.000Z","dependencies_parsed_at":"2022-08-22T20:40:31.031Z","dependency_job_id":null,"html_url":"https://github.com/zhuzixian520/yii2-api-doc","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhuzixian520%2Fyii2-api-doc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhuzixian520%2Fyii2-api-doc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhuzixian520%2Fyii2-api-doc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zhuzixian520%2Fyii2-api-doc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zhuzixian520","download_url":"https://codeload.github.com/zhuzixian520/yii2-api-doc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":219865317,"owners_count":16555929,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","yii2-extension"],"created_at":"2024-07-30T20:01:13.984Z","updated_at":"2025-10-25T17:30:35.305Z","avatar_url":"https://github.com/zhuzixian520.png","language":"PHP","funding_links":[],"categories":["Extension 扩展"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/yiisoft\" target=\"_blank\"\u003e\n        \u003cimg src=\"https://avatars0.githubusercontent.com/u/993323\" height=\"100px\"\u003e\n    \u003c/a\u003e\n    \u003ch1 align=\"center\"\u003eYii2 Annotations Generate API Document Extension\u003c/h1\u003e\n    \u003cbr\u003e\n\u003c/p\u003e\n\n[![Latest Stable Version](https://poser.pugx.org/zhuzixian520/yii2-api-doc/v)](//packagist.org/packages/zhuzixian520/yii2-api-doc) \n[![Total Downloads](https://poser.pugx.org/zhuzixian520/yii2-api-doc/downloads)](//packagist.org/packages/zhuzixian520/yii2-api-doc) \n[![Latest Unstable Version](https://poser.pugx.org/zhuzixian520/yii2-api-doc/v/unstable)](//packagist.org/packages/zhuzixian520/yii2-api-doc) \n[![License](https://poser.pugx.org/zhuzixian520/yii2-api-doc/license)](//packagist.org/packages/zhuzixian520/yii2-api-doc)\n[![Suggesters](https://poser.pugx.org/zhuzixian520/yii2-api-doc/suggesters)](//packagist.org/packages/zhuzixian520/yii2-api-doc)\n[![Dependents](https://poser.pugx.org/zhuzixian520/yii2-api-doc/dependents)](//packagist.org/packages/zhuzixian520/yii2-api-doc)\n\nyii2-api-doc\n============\n通过对yii2的代码注释方便地生成在线api文档\n\n安装\n------------\n\n安装此扩展的首选方式是通过 [composer](http://getcomposer.org/download/).\n\n或者运行\n\n```\ncomposer require --prefer-dist zhuzixian520/yii2-api-doc \"*\"\n```\n\n或者添加\n\n```\n\"zhuzixian520/yii2-api-doc\": \"*\"\n```\n\n到你的`composer.json`文件中的 require 的部分，然后运行\n```\ncomposer install\n```\n\n用法\n-----\n\n一旦扩展安装，只需在您的代码中这样使用它:\n\n```php\nreturn [\n    'modules' =\u003e [\n        'api_doc' =\u003e [\n            'class' =\u003e 'zhuzixian520\\api_doc\\Module',\n            'hostApiDev' =\u003e 'http://api-dev.demo.com',//开发环境接口主机地址\n            'hostApiProd' =\u003e 'http://api.demo.com',//生产环境接口主机地址\n            'hostApiTest' =\u003e 'http://api-test.demo.com',//测试环境接口主机地址\n            'author' =\u003e 'Trevor',\n            'email' =\u003e 'service@wangxiankeji.com',\n            'logo_src' =\u003e '/img/logo_64_64.png',//web目录下\n            'icp_num' =\u003e '粤ICP备15025495号',\n            'copyright_website' =\u003e 'http://www.sijiche.com',\n            'company_start_year' =\u003e '2015',\n        ],\n        'v1' =\u003e [\n            'class' =\u003e 'api\\modules\\v1\\V1Module',\n        ],\n    ],\n];\n```\n\n接口中控制器代码注释\n```php\nclass PassportController extends yii\\rest\\Controller\n{\n    /**\n     * 微信PC网页登录\n     * @method POST\n     * @token 0\n     * @param string code 同意授权后的code 是\n     * @res string token 访问令牌\n     * @return array\n     */\n    public function actionLoginByWechatPc(): array {}\n}\n```\n输出结果\n\n![img.png](img.png)\n\n![img_1.png](img_1.png)\n\n访问接口文档地址\n\n_类似gii与debug，你也可以修改参数V，来切换接口版本_\n\n`\nhttp://yourhost/api_doc?v=1\n`\n\n\n联系作者\n\n邮箱：zhuzixian520@126.com","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzhuzixian520%2Fyii2-api-doc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzhuzixian520%2Fyii2-api-doc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzhuzixian520%2Fyii2-api-doc/lists"}