Changes for page JsonRpcBundle

Last modified by Ashterix on 2024/07/11 13:11

From version 2.1
edited by Ashterix
on 2024/05/08 17:01
Change comment: There is no comment for this version
To version 9.1
edited by Ashterix
on 2024/07/11 13:05
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -3,29 +3,93 @@
3 3  <div style='text-align: center;margin:0 0 10px 0;'><a class="button-link packagist" data-cke-saved-href="https://packagist.org/packages/ufo-tech/json-rpc-bundle" href="https://packagist.org/packages/ufo-tech/json-rpc-bundle"><img data-cke-saved-src="https://packagist.org/img/logo-small.png" src="https://packagist.org/img/logo-small.png">Packagist</a> <a class="button-link" data-cke-saved-href="https://github.com/UFO-Tech/json-rpc-bundle" href="https://github.com/UFO-Tech/json-rpc-bundle"><img data-cke-saved-src="https://camo.githubusercontent.com/dfe7e80288901f8d5e8de7562d6f94491e2a7f8042316fd544fe3b6364b63783/68747470733a2f2f69636f6e2d6c6962726172792e636f6d2f696d616765732f6769746875622d69636f6e2d77686974652f6769746875622d69636f6e2d77686974652d362e6a7067" src="https://camo.githubusercontent.com/dfe7e80288901f8d5e8de7562d6f94491e2a7f8042316fd544fe3b6364b63783/68747470733a2f2f69636f6e2d6c6962726172792e636f6d2f696d616765732f6769746875622d69636f6e2d77686974652f6769746875622d69636f6e2d77686974652d362e6a7067">GitHub</a></div>
4 4  {{/html}}
5 5  
6 -| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
7 -| **Current Version** | ![package_version](https://img.shields.io/github/v/tag/ufo-tech/json-rpc-bundle?color=blue&label=&logo=Packagist&logoColor=white&labelColor=7b8185) |
8 -| **Category** | API |
9 -| **Type** | Symfony Bundle |
10 -| **Dependencies** | ![php_version](https://img.shields.io/packagist/dependency-v/ufo-tech/json-rpc-bundle/php?logo=PHP&logoColor=white)![symfony_version](https://img.shields.io/packagist/dependency-v/ufo-tech/json-rpc-bundle/symfony/framework-bundle?label=Symfony&logo=Symfony&logoColor=white)![symfony_version](https://img.shields.io/packagist/dependency-v/ufo-tech/json-rpc-bundle/symfony/serializer?label=SymfonySerializer&logo=Symfony&logoColor=white)![symfony_version](https://img.shields.io/packagist/dependency-v/ufo-tech/json-rpc-bundle/symfony/serializer?label=SymfonyCache&logo=Symfony&logoColor=white) |
11 -| **Size** | ![Size](https://img.shields.io/github/repo-size/ufo-tech/json-rpc-bundle?label=Size%20of%20the%20repository) |
12 -| **License** | ![License](https://img.shields.io/badge/license-MIT-green?labelColor=7b8185) |
6 +|**Current Version** | [[image:https://img.shields.io/github/v/tag/ufo-tech/json-rpc-bundle?color=blue&label=&logo=Packagist&logoColor=white&labelColor=7b8185]]
7 +| **Category** | Api
8 +| **Type** | Symfony Bundle
9 +| **Dependencies** |[[image:https://img.shields.io/packagist/dependency-v/ufo-tech/json-rpc-bundle/php?logo=PHP&logoColor=white]]
10 +[[image:https://img.shields.io/packagist/dependency-v/ufo-tech/json-rpc-bundle/symfony/framework-bundle?label=Symfony&logo=Symfony&logoColor=white]]
11 +[[image:https://img.shields.io/packagist/dependency-v/ufo-tech/json-rpc-bundle/symfony/serializer?label=SymfonySerializer&logo=Symfony&logoColor=white]]
12 +[[image:https://img.shields.io/packagist/dependency-v/ufo-tech/json-rpc-bundle/symfony/serializer?label=SymfonyCache&logo=Symfony&logoColor=white]]
13 +| **Size** | [[image:https://img.shields.io/github/repo-size/ufo-tech/json-rpc-bundle?label=Size%20of%20the%20repository]]
14 +| **License** | [[image:https://img.shields.io/badge/license-MIT-green?labelColor=7b8185]]
13 13  {{/box}}
14 14  
15 -# Package for Easy Creation of API via JSON-RPC Server
17 += Package for Easy Creation of API via JSON-RPC Server =
16 16  
17 -> Creating RPC services for service-oriented architecture on Symfony has never been easier.
19 +>Creating RPC services for service-oriented architecture on Symfony has never been easier.
18 18  
19 -This package enables the easy creation of APIs using a JSON-RPC server for Symfony v.6.*. It is suitable for developers who want to quickly and efficiently integrate RPC functionality into their projects.
21 +This package makes it easy to create an API using a JSON-RPC server for Symfony v.6.* and later. It is suitable for developers who want to quickly and efficiently integrate RPC functionality into their projects.
22 +{{include reference="docs.JsonRpcBundle.changeLog.7\.0.WebHome"/}}
20 20  
21 -## Key Benefits
24 +== Changes in 7.0 ==
22 22  
26 +=== General Changes ===
27 +
28 +* Changed the API documentation format to support the [[OpenRpc>>https://spec.open-rpc.org/]] standard
29 +* The RPC server lifecycle now operates on [[events and listeners>>doc:docs.JsonRpcBundle.functionality.events.WebHome]].
30 +
31 +=== Configuration ===
32 +
33 +{{warning}}
34 +**WARNING!!!** The configuration has undergone significant changes and is not backward compatible with version 6. See the updated [[documentation>>doc:docs.JsonRpcBundle.config_v7.WebHome]]
35 +{{/warning}}
36 +
37 +* In the {{code language="none"}}security{{/code}} block, HTTP methods are no longer protected; actions (API calls and documentation separately) are protected instead.
38 +* The {{code language="none"}}docs{{/code}} block no longer includes the {{code language="none"}}response{{/code}} block; instead, all properties are now located at its level.
39 +* Deprecated parameters have been removed ({{code language="none"}}docs.response.json_schema{{/code}}).
40 +* New parameters added to the {{code language="none"}}docs{{/code}} block that are used in building the API documentation:
41 +** project_name
42 +** project_description
43 +** project_version
44 +
45 +
46 +== Key Benefits ==
47 +
23 23  * **Ease of Integration**: Integrating this package into your project is extremely straightforward. You simply need to add a special interface to any existing class, and it will automatically gain the capability to handle JSON-RPC requests.
24 24  * **Flexibility**: The package provides great flexibility in API creation, allowing developers to easily extend and modify server behavior without interfering with existing code.
25 25  * **Efficiency**: Thanks to the optimization of calls and the use of modern Symfony components, the package guarantees high performance when processing requests.
26 26  
27 -## Documentation sections
52 +{{include reference="docs.JsonRpcBundle.changeLog.7\.0.WebHome"/}}
28 28  
54 +== Changes in 7.0 ==
55 +
56 +=== General Changes ===
57 +
58 +* Changed the API documentation format to support the [[OpenRpc>>https://spec.open-rpc.org/]] standard
59 +* The RPC server lifecycle now operates on [[events and listeners>>doc:docs.JsonRpcBundle.functionality.events.WebHome]].
60 +
61 +=== Configuration ===
62 +
63 +{{warning}}
64 +**WARNING!!!** The configuration has undergone significant changes and is not backward compatible with version 6. See the updated [[documentation>>doc:docs.JsonRpcBundle.config_v7.WebHome]]
65 +{{/warning}}
66 +
67 +* In the {{code language="none"}}security{{/code}} block, HTTP methods are no longer protected; actions (API calls and documentation separately) are protected instead.
68 +* The {{code language="none"}}docs{{/code}} block no longer includes the {{code language="none"}}response{{/code}} block; instead, all properties are now located at its level.
69 +* Deprecated parameters have been removed ({{code language="none"}}docs.response.json_schema{{/code}}).
70 +* New parameters added to the {{code language="none"}}docs{{/code}} block that are used in building the API documentation:
71 +** project_name
72 +** project_description
73 +** project_version
74 +
75 +
76 +{{include reference="docs.JsonRpcBundle.functionality.WebHome"/}}
77 +
78 +== [[Functionality Provided by the Library>>doc:]] ==
79 +
80 +After installation, you immediately get:
81 +
82 +* An entry point for your Json-RPC API that can accept both synchronous and [[asynchronous requests>>doc:.functionality.async.WebHome]]
83 +* Automatic generation of API capability documentation in json format (see [[Bundle Configuration>>doc:docs.JsonRpcBundle.config_v7.config]])
84 +* The ability to subscribe to RPC server lifecycle events (see [[Lifecycle Events>>doc:.events.WebHome]])
85 +* Batch requests with the ability to use elements of one request's response in the body of another request in the same series (see [[Batch Requests>>doc:.batch.WebHome]])
86 +* Requests with a response to a [[webhook or web-socket>>doc:.callback.WebHome]]
87 +* Caching of method responses that have relatively static results (see [[#~[RPC\Cache~]>>doc:docs.JsonRpcBundle.add_rpc_service.cache.WebHome]])
88 +
89 +
90 +
91 +== Documentation sections ==
92 +
29 29  You can find detailed information about every aspect of using and configuring the library in
30 30  
31 31  {{children/}}