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

Summary

Details

Page properties
Content
... ... @@ -49,10 +49,8 @@
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 -**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.
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}}
53 53  
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 -
56 56  ==== 3.3.1 Edit Resource ====
57 57  
58 58  As mentioned, to have these information explicitly mentioned in your Swagger UI, then you need to define them in your API Catalog. In this catalog page, you can find the resource that you want to work with. Given that your account has an edit permission in Design, then you can click "Edit" of that resource to edit its resource path, which will later be reflected in your Swagger UI (see the blue box below and in the second screenshot of Section 3.3.2 to see how it is reflected in the Swagger UI).
... ... @@ -89,8 +89,10 @@
89 89  
90 90  [[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--edit-request.png]]
91 91  
92 -The screenshot below shows how the Request "Description" is reflected in the Swagger UI.
90 +The screenshot below shows how the request's description, schema, and example value are reflected in the Swagger UI.
93 93  
92 +{{info}}eMagiz will generate the schema and example value of the request message for you by default if you leave them empty.{{/info}}
93 +
94 94  [[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--request-description.png]]
95 95  
96 96  ==== 3.3.5 Edit Responses ====
... ... @@ -99,8 +99,10 @@
99 99  
100 100  [[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--edit-responses.png]]
101 101  
102 -The screenshot below shows what are listed in the "Responses" tab is reflected in the Swagger UI.
102 +The screenshot below shows what are listed in the "Responses" tab is reflected in the Swagger UI. Note that in the example below we show the example message for the 400 HTTP status code.
103 103  
104 +{{info}}eMagiz will generate the schema and example value of the response message for you by default if you leave them empty.{{/info}}
105 +
104 104  [[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--responses-description.png]]
105 105  
106 106  == 4. Key takeaways ==