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

Summary

Details

Page properties
Content
... ... @@ -49,9 +49,11 @@
49 49  
50 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.
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. Once you opened the page, then 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 in the screenshot of Swagger UI below).
53 +
52 52  [[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--edit-operation.png]]
53 53  
54 -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 shows an example of "Financials" as the tag for {{code language='xml'}}/debtor/{code}{{/code}} and {{code}}/invoice{{/code}} operations along with the summaries of each of the resource paths.
56 +Next to that, when you click one of your resources, then you can also edit the "Operations" attached to that resource. In this "Edit Operation" pop-up page (see the screenshot above), 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 shows an example of "Financials" as the tag for {{code language='xml'}}/debtor/{code}{{/code}} and {{code}}/invoice{{/code}} operations along with the summaries of each of the resource paths.
55 55  
56 56  [[image:Main.Images.Microlearning.WebHome@intermediate-api-management-updating-your-api-gateway-operations--tags-summary.png]]
57 57