From 5aea62d0ce54f54ae19686f4942b65315997f01c Mon Sep 17 00:00:00 2001 From: Mahmut Gundogdu Date: Thu, 26 Oct 2023 18:17:25 +0300 Subject: [PATCH 1/4] resolves #2070 --- docs/en/UI/Angular/Service-Proxies.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/en/UI/Angular/Service-Proxies.md b/docs/en/UI/Angular/Service-Proxies.md index 6cd79505c2..992b393d5b 100644 --- a/docs/en/UI/Angular/Service-Proxies.md +++ b/docs/en/UI/Angular/Service-Proxies.md @@ -73,6 +73,17 @@ export const environment: Config.Environment = { > The destination the `proxy` folder is created and the paths above may change based on your project structure. +### Parameters of generate-proxy + +Parameters: +- module or -m: it is backend module name. the default is `app`. the object key of modules defined in response of `api/abp/api-definition`. For example, if you want to generate-proxy of PermissionManagement, you should pass `permissionManagement` as a value. +- apiName or -a: it is Backend api name, a.k.a. remoteServiceName. it defined in the selected module (in response of `api/abp/api-definition`). the property(key) name is `remoteServiceName`. for example for the PermissionManagement, you should pass `AbpPermissionManagement` +- source: Source Angular project for API definition URL & root namespace resolution. +- target: Target Angular project to place the generated code, for example, it is `permission-management`. (npm/ng-packs/packages/*permission-management*). it is folder name. +- entryPoint: Custom place to create generate proxy folder in the target. the place is `permission-management/proxy/src/lib/proxy`. `permission-management` is value of target. if you want to create proxy the place, there is a two option, one you should set value `proxy` as entryPoint. or go to project.json and change `sourceRoot` to `packages/permission-management/proxy/src` from `packages/permission-management/src`. with the property. No need to change sourceRoot of project. if you set empty, proxy generated into folder that defined in sourceRoot property. +- serviceType: the service type of will generate proxy. The options are `application`, `integration` and `all`, Default valueis `application`. A developer can mark a service "integration service". if you want to skip proxy generation for the service, the setting is for you. More info about [Integration Services](../../Integration-Services) + + ### Services The `generate-proxy` command generates one service per back-end controller and a method (property with a function value actually) for each action in the controller. These methods call backend APIs via [RestService](./Http-Requests#restservice). From b9632e5b10844257435a04651c234b6acc649814 Mon Sep 17 00:00:00 2001 From: Masum ULU <49063256+masumulu28@users.noreply.github.com> Date: Fri, 27 Oct 2023 08:26:44 +0300 Subject: [PATCH 2/4] Update Service-Proxies.md --- docs/en/UI/Angular/Service-Proxies.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/en/UI/Angular/Service-Proxies.md b/docs/en/UI/Angular/Service-Proxies.md index 992b393d5b..b577cadd8c 100644 --- a/docs/en/UI/Angular/Service-Proxies.md +++ b/docs/en/UI/Angular/Service-Proxies.md @@ -76,12 +76,12 @@ export const environment: Config.Environment = { ### Parameters of generate-proxy Parameters: -- module or -m: it is backend module name. the default is `app`. the object key of modules defined in response of `api/abp/api-definition`. For example, if you want to generate-proxy of PermissionManagement, you should pass `permissionManagement` as a value. -- apiName or -a: it is Backend api name, a.k.a. remoteServiceName. it defined in the selected module (in response of `api/abp/api-definition`). the property(key) name is `remoteServiceName`. for example for the PermissionManagement, you should pass `AbpPermissionManagement` -- source: Source Angular project for API definition URL & root namespace resolution. -- target: Target Angular project to place the generated code, for example, it is `permission-management`. (npm/ng-packs/packages/*permission-management*). it is folder name. -- entryPoint: Custom place to create generate proxy folder in the target. the place is `permission-management/proxy/src/lib/proxy`. `permission-management` is value of target. if you want to create proxy the place, there is a two option, one you should set value `proxy` as entryPoint. or go to project.json and change `sourceRoot` to `packages/permission-management/proxy/src` from `packages/permission-management/src`. with the property. No need to change sourceRoot of project. if you set empty, proxy generated into folder that defined in sourceRoot property. -- serviceType: the service type of will generate proxy. The options are `application`, `integration` and `all`, Default valueis `application`. A developer can mark a service "integration service". if you want to skip proxy generation for the service, the setting is for you. More info about [Integration Services](../../Integration-Services) +- **module or -m:** it is backend module name. the default is `app`. the object key of modules defined in response of `api/abp/api-definition`. For example, if you want to generate-proxy of PermissionManagement, you should pass `permissionManagement` as a value. +- **apiName or -a:** it is Backend api name, a.k.a. remoteServiceName. it defined in the selected module (in response of `api/abp/api-definition`). the property(key) name is `remoteServiceName`. for example for the PermissionManagement, you should pass `AbpPermissionManagement` +- **source:** Source Angular project for API definition URL & root namespace resolution. +- **target:** Target Angular project to place the generated code, for example, it is `permission-management`. (npm/ng-packs/packages/*permission-management*). it is folder name. +- **entryPoint:** Custom place to create generate proxy folder in the target. the place is `permission-management/proxy/src/lib/proxy`. `permission-management` is value of target. if you want to create proxy the place, there is a two option, one you should set value `proxy` as entryPoint. or go to project.json and change `sourceRoot` to `packages/permission-management/proxy/src` from `packages/permission-management/src`. with the property. No need to change sourceRoot of project. if you set empty, proxy generated into folder that defined in sourceRoot property. +- **serviceType:** the service type of will generate proxy. The options are `application`, `integration` and `all`, Default valueis `application`. A developer can mark a service "integration service". if you want to skip proxy generation for the service, the setting is for you. More info about [Integration Services](../../Integration-Services) ### Services From 37d7f0b992296dc49e63f74cd5e76b767bdeb3bc Mon Sep 17 00:00:00 2001 From: Masum ULU <49063256+masumulu28@users.noreply.github.com> Date: Fri, 27 Oct 2023 08:28:03 +0300 Subject: [PATCH 3/4] Update title of generate-proxy params --- docs/en/UI/Angular/Service-Proxies.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/en/UI/Angular/Service-Proxies.md b/docs/en/UI/Angular/Service-Proxies.md index b577cadd8c..58c731e44c 100644 --- a/docs/en/UI/Angular/Service-Proxies.md +++ b/docs/en/UI/Angular/Service-Proxies.md @@ -73,9 +73,8 @@ export const environment: Config.Environment = { > The destination the `proxy` folder is created and the paths above may change based on your project structure. -### Parameters of generate-proxy +## Parameters of generate-proxy -Parameters: - **module or -m:** it is backend module name. the default is `app`. the object key of modules defined in response of `api/abp/api-definition`. For example, if you want to generate-proxy of PermissionManagement, you should pass `permissionManagement` as a value. - **apiName or -a:** it is Backend api name, a.k.a. remoteServiceName. it defined in the selected module (in response of `api/abp/api-definition`). the property(key) name is `remoteServiceName`. for example for the PermissionManagement, you should pass `AbpPermissionManagement` - **source:** Source Angular project for API definition URL & root namespace resolution. From b7a86bdc6994b2c58c8d03a9eba8f94326b6fa41 Mon Sep 17 00:00:00 2001 From: Hamza Albreem <94292623+braim23@users.noreply.github.com> Date: Tue, 31 Oct 2023 17:02:22 +0300 Subject: [PATCH 4/4] Update Service-Proxies.md --- docs/en/UI/Angular/Service-Proxies.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/en/UI/Angular/Service-Proxies.md b/docs/en/UI/Angular/Service-Proxies.md index 58c731e44c..43b8dc8b0f 100644 --- a/docs/en/UI/Angular/Service-Proxies.md +++ b/docs/en/UI/Angular/Service-Proxies.md @@ -75,12 +75,12 @@ export const environment: Config.Environment = { ## Parameters of generate-proxy -- **module or -m:** it is backend module name. the default is `app`. the object key of modules defined in response of `api/abp/api-definition`. For example, if you want to generate-proxy of PermissionManagement, you should pass `permissionManagement` as a value. -- **apiName or -a:** it is Backend api name, a.k.a. remoteServiceName. it defined in the selected module (in response of `api/abp/api-definition`). the property(key) name is `remoteServiceName`. for example for the PermissionManagement, you should pass `AbpPermissionManagement` -- **source:** Source Angular project for API definition URL & root namespace resolution. -- **target:** Target Angular project to place the generated code, for example, it is `permission-management`. (npm/ng-packs/packages/*permission-management*). it is folder name. -- **entryPoint:** Custom place to create generate proxy folder in the target. the place is `permission-management/proxy/src/lib/proxy`. `permission-management` is value of target. if you want to create proxy the place, there is a two option, one you should set value `proxy` as entryPoint. or go to project.json and change `sourceRoot` to `packages/permission-management/proxy/src` from `packages/permission-management/src`. with the property. No need to change sourceRoot of project. if you set empty, proxy generated into folder that defined in sourceRoot property. -- **serviceType:** the service type of will generate proxy. The options are `application`, `integration` and `all`, Default valueis `application`. A developer can mark a service "integration service". if you want to skip proxy generation for the service, the setting is for you. More info about [Integration Services](../../Integration-Services) +- **module or -m:** The backend module name. The default is `app`. The object key of the modules defined in response of `api/abp/api-definition`. For example, if you want to generate-proxy of PermissionManagement, you should pass `permissionManagement` as a value. +- **apiName or -a:** The Backend api name, also known as remoteServiceName. It is defined in the selected module (in response of `api/abp/api-definition`). The property(key) name is `remoteServiceName`. For example for the PermissionManagement, you should pass `AbpPermissionManagement` +- **source:** Source of the Angular project for the API definition URL & root namespace resolution. +- **target:** Target for the Angular project to place the generated code. For example, if it's `permission-management`, it'll look like this (npm/ng-packs/packages/*permission-management*). +- **entryPoint:** To create the generated proxy folder in the target. The directory is `permission-management/proxy/src/lib/proxy` and the `permission-management` is the value of target. If you want to create a folder for the generated proxy, there are two options, you should either set the value `proxy` as the entryPoint or go to project.json and change the `sourceRoot` from `packages/permission-management/src` to `packages/permission-management/proxy/src`. No need to change the sourceRoot of project with the property. if you keep it empty, the proxy will be generated into the folder defined in the sourceRoot property. +- **serviceType:** The service type of the generated proxy. The options are `application`, `integration` and `all`. The default value is `application`. A developer can mark a service "integration service". If you want to skip proxy generation for the service, then this is the correct setting. More info about [Integration Services](../../Integration-Services) ### Services