Skip to main content

Angular–Generate your OpenAPI client model

Most Angular applications need some kind of data typically provided through an OpenAPI or GraphQL API. Manually creating all the necessary model classes and client can be a time-consuming and error-prone task. In this post we have a look at ng-openapi-gen to help you automate this process.

We start by installing the ng-openapi-gen module by executing the following command:

npm install -g ng-openapi-gen

Now we can generate our models and web client in the Angular application using the following command:

ng-openapi-gen --input <path-to-openapi-json> --output <angular-app-path>/src/app/shared/api

If you look at the command above you see that it requires to an OpenAPI specification file. This can be in JSON or YAML format. So we first need a way to get this specification file.

If you are using ASP.NET Core with the OpenAPI integration, you can either download the OpenAPI file manually by going to the swagger UI and download it there or you can generate the OpenAPI file at build time as I explained in a previous post.

Once you have an OpenAPI file available, we can now execute the command:

ng-openapi-gen --input ../Swashbuckle/api.json --output src/app/shared/api

Let's have a look at what is generated:

  • For every DTO a model class is generated in the models subfolder;
  • For each tag in our OpenAPI specification an Angular @Injectable() service is generated in the services subfolder;
  • An Angular @NgModule() is generated , which provides all services, together with some base classes could be found in the root folder;


Great! Now before we can use these generated module, we need to update our AppModule to import the generated ApiModule and configure the root URL:

Finally we can import and use the generated client in our Angular components or if we are using NgRx in our effects:

Labels:

Popular posts from this blog

.NET 8–Keyed/Named Services

A feature that a lot of IoC container libraries support but that was missing in the default DI container provided by Microsoft is the support for Keyed or Named Services. This feature allows you to register the same type multiple times using different names, allowing you to resolve a specific instance based on the circumstances. Although there is some controversy if supporting this feature is a good idea or not, it certainly can be handy. To support this feature a new interface IKeyedServiceProvider got introduced in .NET 8 providing 2 new methods on our ServiceProvider instance: object? GetKeyedService(Type serviceType, object? serviceKey); object GetRequiredKeyedService(Type serviceType, object? serviceKey); To use it, we need to register our service using one of the new extension methods: Resolving the service can be done either through the FromKeyedServices attribute: or by injecting the IKeyedServiceProvider interface and calling the GetRequiredKeyedServic...
Read more

Azure DevOps/ GitHub emoji

I’m really bad at remembering emoji’s. So here is cheat sheet with all emoji’s that can be used in tools that support the github emoji markdown markup: All credits go to rcaviers who created this list.
Read more

Kubernetes–Limit your environmental impact

Reducing the carbon footprint and CO2 emission of our (cloud) workloads, is a responsibility of all of us. If you are running a Kubernetes cluster, have a look at Kube-Green . kube-green is a simple Kubernetes operator that automatically shuts down (some of) your pods when you don't need them. A single pod produces about 11 Kg CO2eq per year( here the calculation). Reason enough to give it a try! Installing kube-green in your cluster The easiest way to install the operator in your cluster is through kubectl. We first need to install a cert-manager: kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.14.5/cert-manager.yaml Remark: Wait a minute before you continue as it can take some time before the cert-manager is up & running inside your cluster. Now we can install the kube-green operator: kubectl apply -f https://github.com/kube-green/kube-green/releases/latest/download/kube-green.yaml Now in the namespace where we want t...
Read more