README

Symfony扩展，用于轻松生成JSON-RPC服务器文档

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

有关参数文档生成的详细信息，请参阅adgoal/symfony-jsonrpc-params-sf-constraints-doc。

支持的格式

原始：内置的json格式在/doc或/doc/raw.json
Swagger：adgoal/symfony-jsonrpc-http-server-swagger-doc
OpenApi：adgoal/symfony-jsonrpc-http-server-openapi-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'

按照adgoal/symfony-jsonrpc-http-server文档中的说明注册JSON-RPC方法。
在/doc端点查询您的项目，您将获得服务器文档的json格式。

贡献

请参阅贡献指南

adgoal/symfony-jsonrpc-http-server-doc

维护者

详细信息

README

支持的格式

如何使用

配置

贡献