Skip to Content
Last modified by Danniar Firdausy on 2024/09/30 17:12
From version 35.83
edited by Danniar Firdausy
on 2024/09/30 12:54
Change comment: There is no comment for this version
To version 35.87
edited by Danniar Firdausy
on 2024/09/30 13:01
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -47,9 +47,9 @@
47 47  
48 48  === 3.3 Updating the Swagger UI ===
49 49  
50 -Additionally, you can also update the Swagger UI of your API Gateway solution, so that it better informs your (external) parties to see the specifications of your API Gateway. As you have learned from the [[previous microlearning>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-swagger-ui||target="blank"]], the Swagger UI contains information on, not only Authorization, HTTP Resource Paths, and HTTP Operations, but also schemas, example messages, tags, and descriptions if defined. Through the API Catalog in Design>Solution Design, you are able to configure almost all fields that you can see in the Swagger UI.
50 +Additionally, you can also update the Swagger UI of your API Gateway solution, so that it better informs your (external) parties to see the specifications of your API Gateway. As you have learned from the [[previous microlearning>>doc:Main.eMagiz Academy.Microlearnings.Crash Course.Crash Course API Gateway.crashcourse-api-gateway-swagger-ui||target="blank"]], the Swagger UI contains information on, not only Authorization, HTTP Resource Paths, and HTTP Operations, but also schemas, example messages, tags, and descriptions if defined. You are able to configure almost all fields that you can see in the Swagger UI through the API Catalog in Design>Solution Design.
51 51  
52 -Note that, as is the case with all new versions in Create, the changes will only be effective when you deploy your solution via the eMagiz Deploy phase.
52 +**Note**: as is the case with all new versions in Create, the changes will only be effective when you deploy your solution via the eMagiz Deploy phase.
53 53  
54 54  {{info}}To ensure that the changes below to your Swagger file generated by eMagiz are shown to the end-user, the latest version of the API Gateway runtime infra flow needs to be included in the release and deployed to the correct environment.{{/info}}
55 55  
... ... @@ -69,6 +69,10 @@
69 69  
70 70  [[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--tags-summary.png]]
71 71  
72 +Additionally, the value that you use as a "Tags" of an operation will also be reflected in the gateway message definition page of that (see the screenshot below).
73 +
74 +[[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--gateway-message-tags.png]]
75 +
72 72  ==== 3.3.3 Edit Parameters ====
73 73  
74 74  Still in the API Catalog page, right next to that "Operations" of that resource, you will see "Parameters", "Request" (only for non-GET operation), and "Responses" tabs.