109
Views
2
Comments
How to change the layout of REST API documentation (swagger) page?
Question
Application Type
Service

Hello, 

I am exposing few APIs from OutSystems Service module where I can see API Documentation page with Swagger documentation. It is currently showing OutSystems header and logo but I would like to customise the page layout to have my company's brand logo and colour on the header and footer. 

Please can someone advise how to achieve this?

Thanks in advance!

2023-04-19 18-38-51
Bas de Jong

As far as i know, this is not possible. The only things you can change are the descriptions which are configured in the description boxes of the REST API you are exposing in Service Studio. Maybe you can submit this to OutSystems as an Idea because it would indeed be nice to have some more customization there!

2018-01-05 02-53-30
Grayson Udstrand

Hello Karthik, I don't believe you can customize that swagger document. It is automatically generated based on your implementation so your ability to change the visual elements is pretty much restricted to renaming endpoints so they appear in a different order. However that is strongly discouraged since resource naming is sort of a fundamental tenant of RESTful interfaces.

There's nothing stopping you from using swaggers tools, however, to make your own swagger doc with whatever limited customizations you need. The issue is that it would be more work for you to keep the specification updated over time (as OutSystems won't just automatically push updated documentation to wherever you are hosting the spec) but this would allow you to make those changes you have asked about. 

Community GuidelinesBe kind and respectful, give credit to the original source of content, and search for duplicates before posting.