yoanm/symfony-jsonrpc-http-server-doc

Symfony扩展,用于简化JSON-RPC服务器文档的生成

v1.1.0 2023-04-10 11:25 UTC

This package is auto-updated.

Last update: 2024-09-10 15:00:29 UTC


README

License Code size Dependabot Status

Scrutinizer Build Status Scrutinizer Code Quality Codacy Badge

CI codecov Symfony Versions

Latest Stable Version Packagist PHP version

Symfony扩展,用于简化JSON-RPC服务器文档的生成

Symfony扩展,用于yoanm/jsonrpc-server-doc-sdk

有关参数文档生成的信息,请参阅yoanm/symfony-jsonrpc-params-sf-constraints-doc

可用格式

如何使用

配置完成后,您的项目即可处理位于/doc/{?filename}端点的HTTP GET请求。

以下是如何配置的示例。

配置

Behat演示应用配置文件夹可以作为示例使用。

  • 在您的config/bundles.php文件中添加以下内容

    // config/bundles.php
    return [
        ...
        Symfony\Bundle\FrameworkBundle\FrameworkBundle::class => ['all' => true],
        Yoanm\SymfonyJsonRpcHttpServer\JsonRpcHttpServerBundle::class => ['all' => true],
        Yoanm\SymfonyJsonRpcHttpServerDoc\JsonRpcHttpServerDocBundle::class => ['all' => true],
        ...
    ];
  • 在您的路由配置中添加以下内容

    # config/routes.yaml
    json-rpc-endpoint:
      resource: '@JsonRpcHttpServerBundle/Resources/config/routing/endpoint.xml'
    
    json-rpc-endpoint-doc:
      resource: '@JsonRpcHttpServerDocBundle/Resources/config/routing/endpoint.xml'
  • 在您的配置中添加以下内容

    # config/config.yaml
    framework:
      secret: '%env(APP_SECRET)%'
    
    json_rpc_http_server: ~
    
    json_rpc_http_server_doc: ~
    # Or the following in case you want to customize endpoint path
    #json_rpc_http_server_doc:
    #  endpoint: '/my-custom-doc-endpoint' # Default to '/doc'
  • 按照yoanm/symfony-jsonrpc-http-server文档中的说明注册JSON-RPC方法。

  • /doc端点查询您的项目,您将获得服务器文档的json格式。

贡献

请参阅贡献指南