Changes for page JsonRpcBundle

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

From version 8.1
edited by Ashterix
on 2024/07/11 13:04
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
... ... @@ -21,6 +21,28 @@
21 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 22  {{include reference="docs.JsonRpcBundle.changeLog.7\.0.WebHome"/}}
23 23  
24 +== Changes in 7.0 ==
25 +
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 +
24 24  == Key Benefits ==
25 25  
26 26  * **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.
... ... @@ -28,9 +28,44 @@
28 28  * **Efficiency**: Thanks to the optimization of calls and the use of modern Symfony components, the package guarantees high performance when processing requests.
29 29  
30 30  {{include reference="docs.JsonRpcBundle.changeLog.7\.0.WebHome"/}}
53 +
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 +
31 31  {{include reference="docs.JsonRpcBundle.functionality.WebHome"/}}
32 32  
78 +== [[Functionality Provided by the Library>>doc:]] ==
33 33  
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 +
34 34  == Documentation sections ==
35 35  
36 36  You can find detailed information about every aspect of using and configuring the library in