Support

Expand all | Collapse all

Swagger shows raw json vs interactive tool

Jump to Best Answer
  • 1.  Swagger shows raw json vs interactive tool

    Posted 01-31-2017 15:03
    I am trying to use the swagger tool (http://server/rest/latest/api-docs).  However, instead of showing the interactive tool, I am getting the raw json data.  Can someone please let me know what is needed? Are we missing some type of configurations or options?

    {"swagger":"2.0","info":{"description":"This is the documentation for the Jama REST API.","version":"latest","title":"Jama REST API","contact":{"name":"support@jamasoftware.com","url":"https://dev.jamasoftware.com"}},"host":"172.21.110.31","basePath":"/rest/latest","tags":[{"name":"picklists"},{"name":"relationships"},{"name":"projects"},{"name":"testruns"},{"name":"filters"},{"name":"testcycles"},{"name":"usergroups"},{"name":"itemtypes"},{"name":"comments"},{"name":"activities"},{"name":"attachments"},{"name":"users"},{"name":"picklistoptions"},{"name":"tags"},{"name":"baselines"},{"name":"abstractitems"},{"name":"relationshiptypes"},{"name":"items"},{"name":"files"},{"name":"system"},{"name":"releases"},{"name":"testplans"}],"schemes":["http"],"paths":{"/abstractitems":{"get":{"tags":["abstractitems"],"summary":"Search for items,


    ------------------------------
    Tammy
    ------------------------------


  • 2.  RE: Swagger shows raw json vs interactive tool

    Posted 01-31-2017 17:11
    URL should be

    Http://server/context/api-docs

    Ours is http://jama/contour/api-docs

    ------------------------------
    Sam
    ------------------------------



  • 3.  RE: Swagger shows raw json vs interactive tool

    Posted 02-01-2017 09:29
    Thanks for the reply.  But I am looking to see the tool below.  I am using http://jama-dev/rest/latest/api-docs, but it doesn't give me the tool - only json text.  How do I see the documentation tool?



    ------------------------------
    Tammy
    ------------------------------



  • 4.  RE: Swagger shows raw json vs interactive tool

    Posted 02-01-2017 09:32

    > jama-dev/rest/latest/api-docs,

     

    Again you have the wrong URL.  That is the direct api, NOT the swagger URL.

    ( I made this mistake too, that's how I know)..

     

    What url do you use to use the Jama UI?

     

    Sam

     






  • 5.  RE: Swagger shows raw json vs interactive tool

    Posted 02-01-2017 10:28
    I use http://jama-dev or http://jama-dev/perspective.req#/home

    ------------------------------
    Tammy
    ------------------------------



  • 6.  RE: Swagger shows raw json vs interactive tool
    Best Answer

    Posted 02-01-2017 10:29

    Ok, then to access the swagger UI for that server and context

     

    http://jama-dev/perspective.req/api-docs

    as I documented earlier

     

    Sam

     






  • 7.  RE: Swagger shows raw json vs interactive tool

    Posted 02-01-2017 11:11
    Ahhhhhh... http://jama-dev/api-docs works.  Thank you!

    ------------------------------
    Tammy
    ------------------------------