Skip to Content
Last modified by Danniar Firdausy on 2024/09/30 17:12
From version 35.13
edited by Danniar Firdausy
on 2024/09/27 14:34
Change comment: There is no comment for this version
To version 35.12
edited by Danniar Firdausy
on 2024/09/27 14:09
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -47,12 +47,10 @@
47 47  
48 48  === 3.3 Updating the Swagger UI ===
49 49  
50 -Next to that, 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, and descriptions if defined.
50 +Next to that, 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, and descriptions if defined. Thus, to have these information explicitly mentioned in your Swagger UI, then you need to define them in your API Catalog in Design.
51 51  
52 -To have these information explicitly mentioned in your Swagger UI, then you need to define them in your API Catalog in Design. When you access it and select one of your resources, then you can edit the "Operations" attached to that resource. In this "Edit Operation" pop-up page, first of all, you can specify the HTTP method of that operation. Next to that, you can also specify the "Tags" and the "Summary" of that operation. The "Summary" here shortly describes your resource path and will be shown beside the path of your resource. Whereas, the "Tags" here will group together the operations with the same tag names in your Swagger UI. Thus, the screenshot below shown an example of "Financials" as the tag for {{code}}/debtor/{code}{{/code}} and {{code}}/invoice{{/code}}
53 53  
54 54  
55 -
56 56  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.
57 57  
58 58  {{info}}To ensure that the changes 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}}