Error accessing GS Swagger UI

Question

Hello SDL and readers, 
 When I try to access a swagger documentation page I get a generic 500 error. 
 Here's a sample from http://gs2017dev.sdl.com:41234/documentation/api/index# 
 
 and i can't see the api methods list below the main info text. 
 
 This happens also on our groupshare server (2017 SR1 cu10). 
 Can anything be done? 
 Is there an alternative documentation to see all the api calls available with their parameters? 
 I'd add that interrogation of the API works, but having to develop new parts, documentation is necessary. 
 Thank you very much for your (future) help.

Paul · Accepted Answer

Enrico Rosso

One time fix:

On the GroupShare server edit “c:\Program Files(x86)\SDL\SDL Server\Web\swagger-ui\groupshare.json”:
Replace “host”:”localhost:41234” with “host”:”servername” (without port)

Then each time you want to use swagger:

In your browser access http://<servername>/documentation/api/index (again no port)
Replace http://<servername>:41234/docs/v2 in the top of the page by http://<servername>/swagger-ui/GroupShare.json (again no port)
Click “Explore”

You should now be able to use swagger interactively and you should not need any port open with the exception of port 80.

Paul Filkin | RWS Group

________________________
Design your own training!
You've done the courses and still need to go a little further, or still not clear?
Tell us what you need in our Community Solutions Hub

GroupShare Developers > GroupShare Developers forum

Error accessing GS Swagger UI

Top Replies