Skip to Content
Last modified by Danniar Firdausy on 2024/09/30 17:12
From version 35.99
edited by Danniar Firdausy
on 2024/09/30 17:05
Change comment: There is no comment for this version
To version 35.101
edited by Danniar Firdausy
on 2024/09/30 17:09
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -49,7 +49,7 @@
49 49  
50 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 -{{info}}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. 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}}
52 +{{info}}As with all new flow versions in Create, changes will take effect only after deploying via Deploy phase, and to show the changes in the Swagger file to the end-user, the latest version of the API Gateway infra flow must be included and deployed.{{/info}}
53 53  
54 54  ==== 3.3.1 Edit Resource ====
55 55  
... ... @@ -83,8 +83,10 @@
83 83  
84 84  ==== 3.3.4 Edit Request ====
85 85  
86 -Quite similar with the "Parameters" tab, in the "Request" tab of the API Catalog page, you can also specify the description (see the orange box) and whether the request body is required in the request. Next to that, you can also specify yourself the schema and the example value for the request message (see the blue box). **Note** that this tab is only visible for non-GET operation.
86 +Quite similar with the "Parameters" tab, in the "Request" tab of the API Catalog page, you can also specify the description (see the orange box) and whether the request body is required in the request. Next to that, you can also specify yourself the schema and the example value for the request message (see the blue box).
87 87  
88 +{{info}}This tab is only visible for non-GET operation{{/info}}
89 +
88 88  [[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--edit-request.png]]
89 89  
90 90  The screenshot below shows how the request's description, schema, and example value are reflected in the Swagger UI.