Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update "Microservice Solution: How to use with ABP Suite" documentation for Suite UI Code Generation #21131

Merged
merged 3 commits into from
Oct 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,54 @@ You can open ABP Suite from ABP Studio by using the **ABP Suite** -> **Open** to

![abp-suite-context-menu](images/abp-suite-context-menu.png)

It opens the ABP Suite in a built-in browser window. You can also access the suite by visiting `http://localhost:3000` through your browser. From there, you can visually design your solution and generate code. In this example, we create a **Product** entity.
It opens the ABP Suite in a built-in browser window. You can also access the suite by visiting `http://localhost:3000` through your browser. From there, you can visually design your solution and generate code.

In the following example, we've defined the entity name as **Product** and provide other metadata for the related entity:

![abp-suite-product-entity](images/abp-suite-product-entity.png)

After clicking **Save and generate** for the entity in ABP Suite, use **Run** -> **Build & Restart** in the [Solution Runner](../../studio/running-applications.md#start) to apply the changes.

To confirm, visit the Swagger UI to verify that the necessary API endpoints and services have been created.
> ABP Suite requires you to stop all running instances in the related solution/project to be able to generate codes properly. Otherwise, it might not work effectively.

Then, to confirm, you can visit the Swagger UI to verify that the necessary API endpoints and services have been created.

![abp-suite-product-services](images/abp-suite-product-services.png)

> Currently, you can't generate UI code with ABP Suite for microservice solutions. This feature will be added in future releases.
If you selected the *Create user interface* option for the entity, the related UI components (pages, styles, scripts etc.) will also be created. To be able to see the related pages in your host application/UI you should apply the following steps:

1. Generate [*client-proxies*](../../framework/api-development/static-csharp-clients.md) with the following command:

```bash
abp generate-proxy -t csharp -url http://localhost:{your-service-port}/ -m {remote-service-name} --without-contracts
```

* You should run this command in the directory of your host application, and your microservices should be up and running.
* The command will generate proxy classes for your microservice in the host application, which you can see under the **ClientProxies** folder.

> **Note:** After each entity generation/modification in your services, then you should run this command to update client-proxies.

2. Configure the application for the static client proxy:

```csharp
public class MyClientAppModule : AbpModule
{
public override void ConfigureServices(ServiceConfigurationContext context)
{
// Prepare for static client proxy generation
context.Services.AddStaticHttpClientProxies(
typeof(MyServiceApplicationContractsModule).Assembly
);

// Include the generated app-generate-proxy.json in the virtual file system
Configure<AbpVirtualFileSystemOptions>(options =>
{
options.FileSets.AddEmbedded<MyClientAppModule>();
});
}
}
```

After you apply these steps, you're ready to go to run your microservices and see the generated CRUD pages:

![abp-suite-product-pages](images/abp-suite-products-pages.png)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.