请选择 进入手机版 | 继续访问电脑版
  • 设为首页
  • 点击收藏
  • 手机版
    手机扫一扫访问
    迪恩网络手机版
  • 关注官方公众号
    微信扫一扫关注
    公众号

imi-apidoc: 支持在项目中使用 Swagger 注解语法,运行命令,生成 Swagger 文件 ...

原作者: [db:作者] 来自: 网络 收藏 邀请

开源软件名称:

imi-apidoc

开源软件地址:

https://gitee.com/imiphp/imi-apidoc

开源软件介绍:

imi-apidoc

Latest VersionPhp VersionSwoole VersionIMI License

介绍

支持在项目中使用 Swagger 注解语法,运行命令,生成 Swagger 文件。

Swagger 是最流行的 API 开发工具,它遵循 OpenAPI Specification(OpenAPI 规范,也简称 OAS)。

Swagger 可以贯穿于整个 API 生态,如 API 的设计、编写 API 文档、测试和部署。

Swagger 是一种通用的,和编程语言无关的 API 描述规范。

imi-apidoc 基于 zircote/swagger-php 开发,100% 支持写法。

Composer

本项目可以使用composer安装,遵循psr-4自动加载规则,在你的 composer.json 中加入下面的内容:

{    "require": {        "imiphp/imi-apidoc": "^1.0.0"    }}

然后执行 composer update 安装。

使用说明

可以参考 exampletests 目录示例。

项目配置文件:

[    'components'    =>  [        'ApiDoc'  =>  'Imi\ApiDoc',    ],]

Swagger 书写文档说明:https://zircote.github.io/swagger-php/Getting-started.html#annotation-placement

Demo:

<?phpnamespace ImiApp\ApiServer\Controller;use Imi\Server\Route\Annotation\Route;use Imi\Server\Route\Annotation\Action;use Imi\Controller\SingletonHttpController;use Imi\Server\Route\Annotation\Controller;/** * @OA\Info(title="My First API", version="0.1") * @Controller("/") */class IndexController extends SingletonHttpController{    /**     * @Action     * @Route("/")     *      *     * @return void     */    public function index()    {    }    /**     * @Action     * @Route(url="login", method="POST")     *     * @param string $username 用户名     * @param integer $password 密码     *      * @return void     */    public function login(string $username, int $password)    {    }    /**     * @Action     * @Route("register")     * @OA\Get(     *     path="/register",     *     @OA\Response(response="200", description="An example resource")     * )     *     * @param string $username 用户名     * @param integer $password 密码     * @param string $birthday 生日     *      * @return void     */    public function register(string $username, int $password    , string $birthday)    {    }    /**     * @Action     *     * @param int $id     * @return void     */    public function get(int $id)    {    }}

imi-apidoc 会根据 @Route 注解、@param 注释,自动补足相关信息。让你不必为每个接口都书写 Swagger 注解,提升开发效率。

当然,如果希望更加个性化的信息设置,还是要自己去书写的!

生成命令:

Yaml 格式: imi doc/api -to api.yml

Json 格式: imi doc/api -to api.json

指定扫描的命名空间:imi doc/api -to api.json -namespace "ImiApp\Controller1,ImiApp\Controller2"

效果:

免费技术支持

QQ群:17916227 点击加群,如有问题会有人解答和修复。

运行环境

版权信息

imi-apidoc 遵循 MIT 开源协议发布,并提供免费使用。

捐赠

开源不求盈利,多少都是心意,生活不易,随缘随缘……


鲜花

握手

雷人

路过

鸡蛋
该文章已有0人参与评论

请发表评论

全部评论

热门推荐
阅读排行榜
  • ** REJECT ** DO NOT USE THIS CANDIDATE NUMBER. ConsultIDs: none. Reason: This ca

    阅读:234|2022-09-23
  • Simple Task Scheduling System v1.0 was discovered to contain a SQL injection vul

    阅读:207|2022-09-18
  • Simple Task Scheduling System v1.0 was discovered to contain a SQL injection vul

    阅读:218|2022-09-18
  • Novel-Plus v3.6.2 was discovered to contain a hard-coded JWT key located in the

    阅读:224|2022-09-18
  • Novel-Plus v3.6.2 was discovered to contain an arbitrary file download vulnerabi

    阅读:224|2022-09-18
  • Simple Task Scheduling System v1.0 was discovered to contain a SQL injection vul

    阅读:127|2022-09-18
  • An issue was discovered in the Arm Mali GPU Kernel Driver. A non-privileged user

    阅读:246|2022-09-18
  • HashiCorp Boundary up to 0.10.1 did not properly perform data integrity checks t

    阅读:184|2022-09-18
  • In D-Link DIR-816 A2_v1.10CNB04.img a command injection vulnerability occurs in

    阅读:215|2022-09-18
  • D-Link DIR-816 A2_v1.10CNB04.img is vulnerable to Command Injection via /goform/

    阅读:190|2022-09-18

扫描微信二维码

查看手机版网站

随时了解更新最新资讯

139-2527-9053

在线客服(服务时间 9:00~18:00)

在线QQ客服
地址:深圳市南山区西丽大学城创智工业园
电邮:jeky_zhao#qq.com
移动电话:139-2527-9053

Powered by 互联科技 X3.4© 2001-2213 极客世界.|Sitemap