yoanm / symfony-jsonrpc-http-server-doc
Symfony扩展,用于简化JSON-RPC服务器文档的生成
v1.1.0
2023-04-10 11:25 UTC
Requires
- php: ^8.0
- ext-json: *
- symfony/config: ^4.4 || ^5.4 || ^6.0
- symfony/dependency-injection: ^4.4 || ^5.4 || ^6.0
- symfony/event-dispatcher-contracts: ^1.0 || ^2.0
- symfony/http-foundation: ^4.4 || ^5.4 || ^6.0
- symfony/http-kernel: ^4.4 || ^5.4 || ^6.0
- yoanm/jsonrpc-server-doc-sdk: ^0.3 || ^1.0
- yoanm/jsonrpc-server-sdk: ^3.3
- yoanm/symfony-jsonrpc-http-server: ^3.3
Requires (Dev)
- behat/behat: ^3.9.0
- dvdoug/behat-code-coverage: ^5.0
- matthiasnoback/symfony-config-test: ^4.0
- matthiasnoback/symfony-dependency-injection-test: ^4.0
- phpspec/prophecy: ^1.15
- phpspec/prophecy-phpunit: ^2.0
- phpunit/php-code-coverage: ^9.2.4
- phpunit/phpunit: ^9.0
- squizlabs/php_codesniffer: ^3.5
- symfony/framework-bundle: ^4.4 || ^5.4 || ^6.0
- symfony/routing: ^4.4 || ^5.4 || ^6.0
- yoanm/php-unit-extended: ^2.0.2
Suggests
- yoanm/symfony-jsonrpc-http-server: Symfony Bundle to convert an HTTP json-rpc request into HTTP json-rpc response
- yoanm/symfony-jsonrpc-http-server-openapi-doc: Symfony bundle for easy JSON-RPC server OpenAPI 3.0.0 documentation
- yoanm/symfony-jsonrpc-http-server-swagger-doc: Symfony bundle for easy JSON-RPC server Swagger 2.0 documentation
- yoanm/symfony-jsonrpc-params-sf-constraints-doc: Symfony bundle for easy Symfony constraints to JSON-RPC documentation transformation
This package is auto-updated.
Last update: 2024-09-10 15:00:29 UTC
README
Symfony扩展,用于简化JSON-RPC服务器文档的生成
Symfony扩展,用于yoanm/jsonrpc-server-doc-sdk
有关参数文档生成的信息,请参阅yoanm/symfony-jsonrpc-params-sf-constraints-doc
可用格式
- 原始:在
/doc
或/doc/raw.json
内置的json
格式 - Swagger:yoanm/symfony-jsonrpc-http-server-swagger-doc
- OpenApi:yoanm/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'
-
按照yoanm/symfony-jsonrpc-http-server文档中的说明注册JSON-RPC方法。
-
在
/doc
端点查询您的项目,您将获得服务器文档的json
格式。
贡献
请参阅贡献指南