Question Re: API 'Try Out' feature disabled when using security schema in OpenAPI spec in Technology Q&A

API 'Try Out' feature disabled when using security schema in OpenAPI spec

Former Member — Tue, 17 Nov 2020 13:00:17 GMT

Hi,

On the SwaggerHub website I noticed that their editor tool has an 'Authorize' feature that is capable of obtaining a token needed for an OAuth protected endpoint:

I can't find anything similar when using either the SAP API Designer tool or the Developer Portal. At the moment it seems as though the 'try out' feature wont be available if I've configured the OpenAPI (v3) spec to use a security schema.

securitySchemes:
    erpsalesorder_auth:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: 'https://{url to my oauth generator endpoint}'
          scopes:
            'read:SalesHeader': read your salesorder
...
...
...
     security:
        - erpsalesorder_auth:
            - 'read:SalesHeader'

In the below image you'll see that the 'Try Out' button is disabled. If the items above relating to the security schema are removed, the feature becomes available again.

I'm assuming the missing 'Authorize' feature is probably due to the editor lagging behind the version in use on the SwaggerHub website? How are others 'trying out' endpoints in the developer portal when an OAuth token is needed?

TIA!

Re: API 'Try Out' feature disabled when using security schema in OpenAPI spec

mike_zaschka — Fri, 30 Apr 2021 13:59:24 GMT

Hey loganuk,
it seems that I posted a kind of similar question on the securitySchemes:
https://answers.sap.com/questions/13359297/sap-api-management-developer-portal-and-openapi-se.html

Did you receive any feedback outside of the SAP Community or did you find a solution for this?

Re: API 'Try Out' feature disabled when using security schema in OpenAPI spec

former_member105769 — Tue, 07 Feb 2023 13:34:31 GMT

I have exactly the same question.
Seems disappointing that no one has answered.