Changes for page 2. Налаштування бандла

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

From 4.1 to 5.1

From version 1.1

edited by Ashterix
on 2024/07/11 11:46

Change comment: There is no comment for this version

To version 4.1

edited by Ashterix
on 2024/07/11 11:48

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)

Details

Page properties

Title

@@ -1,1 +1,1 @@
--2. Bundle settings
++2. Bundle config

Content

@@ -48,6 +48,8 @@
  - RFC Norms: Header requirements are regulated by RFC documents that define Internet protocol standards. For example, common headers and their use are described in RFC 7231.
  {{/spoiler}}
++
++
  Parameter {{code language="none"}}clients_tokens{{/code}}
  Next, specify an array of client tokens that will have access to the API.
@@ -182,5 +182,118 @@
  * {{code language="none"}}project_description{{/code}}: The project description
  * {{code language="none"}}project_version{{/code}}: The current version of your API
  * {{code language="none"}}async_dsn_info{{/code}}: Indicates whether to display information about asynchronous transport in the documentation
--* (% id="cke_bm_826282S" style="display:none" %){{code language="none"}}validations.symfony_asserts{{/code}}{{code language="none"}}validations.symfony_asserts{{/code}}(%%
++* (% id="cke_bm_826282S" style="display:none" %){{code language="none"}}validations.symfony_asserts{{/code}}{{code language="none"}}validations.symfony_asserts{{/code}}{{code language="none"}}validations.symfony_asserts{{/code}}(%%): <bool> Indicates whether to display the validation constraint string for the parameter (if you use [[validation>>doc:docs.JsonRpcBundle.add_rpc_service.assertions.WebHome]])
++{{code language="yaml" layout="LINENUMBERS" title="config/packages/ufo_json_rpc.yaml"}}
++ufo_json_rpc:
++    docs:
++        project_name: 'My Project'
++        project_description: 'My project description'
++        project_version: '1.0'
++        # Optional response details
++        async_dsn_info:  false          # Provide information about API that work asynchronously
++        validations:
++            symfony_asserts: false      # Indicates if an array of Symfony validation constraints is used
++
++{{/code}}
++
++{{info}}
++Do not worry about the security of your authorization data contained in the DSN.
++
++The documenter is designed in such a way that before displaying DSN information, it removes user and password data, as well as other secret data such as tokens, secret keys, etc.
++
++The template for protection is {{code language="none"}}/([\w\d_]*(?:secret|access|token|key)[_\w]*)=((?:\w|\d)+(?=&?))/{{/code}}.
++
++Example:
++
++{{code language="json" layout="LINENUMBERS" title="RPC_TRANSPORT_DSN=https://sqs.eu-west-3.amazonaws.com/123456789012/messages?access_key=AKIAIOSFODNN7EXAMPLE&secret_key=j17M97ffSVoKI0briFoo9a"}}
++{
++    "async": {
++        "scheme": "https",
++        "host": "sqs.eu-west-3.amazonaws.com",
++        "path": "/123456789012/messages",
++        "query": "access_key={access_key}&secret_key={secret_key}"
++    }
++}
++{{/code}}
++{{/info}}
++
++=== Documentation Example ===
++
++{{code language="json" layout="LINENUMBERS" title="GET: /api"}}
++{
++   "openrpc":"1.2.6",
++   "info":{
++      "title":"My Project",
++      "description":"My project description",
++      "contact":{
++         "name":"ufo-tech/json-rpc-bundle",
++         "url":"https://docs.ufo-tech.space/bin/view/docs/JsonRpcBundle/?language=en"
++      },
++      "license":{
++         "name":"MIT"
++      },
++      "version":"1.0"
++   },
++   "servers":[
++      {
++         "url":"https://mysite.com/api",
++         "description":"Json-RPC api server from UFO Tec\n\nUFO Tech, or Universal Flexible Open Technologies, is an initiative aimed at providing PHP developers with tools to create complex yet user-friendly solutions for modern web applications and service-oriented architectures.",
++         "name":"UFO Json-RPC Server v.7.0.0",
++         "x-method":"POST",
++         "x-ufo":{
++            "envelop":"JSON-RPC-2.0/UFO-RPC-7.0.0",
++            "transport":{
++               "sync":{
++                  "scheme":"https",
++                  "host":"mysite.com",
++                  "path":"/api",
++                  "method":"POST"
++               },
++               "async":{
++                  "scheme":"amqp",
++                  "user":"{user}",
++                  "pass":"{pass}",
++                  "host":"mysite.com",
++                  "port":5672,
++                  "path":"/%2f/json-rpc"
++               }
++            },
++            "documentation":{
++               "json-rpc":"https://www.jsonrpc.org/specification",
++               "ufo-tech/json-rpc-bundle":"https://docs.ufo-tech.space/bin/view/docs/JsonRpcBundle/?language=en"
++            }
++         }
++      }
++   ],
++   "methods":[
++      {
++         "name":"getUserNameByUuid",
++         "tags":[
++            {
++               "name":"App\\Api\\UserApiService"
++            }
++         ],
++         "summary":"Get username by id",
++         "params":[
++            {
++               "name":"userId",
++               "description":"User Id format uuid",
++               "required":true,
++               "schema":{
++                  "type":"string"
++               },
++               "x-ufo-assertions": "new Assert\\Uuid()"
++            }
++         ],
++         "result":{
++            "name":"string",
++            "description":"User Name",
++            "schema":{
++               "type":"string"
++            }
++         }
++      }
++   ]
++}
++{{/code}}

Changes for page 2. Налаштування бандла

Summary

Details

Navigation

Child Pages