Forum Discussion

shivasai's avatar
shivasai
New Contributor
2 years ago

How to add examples/API key values in swagger document

I want to add the header key as X-API-KEY and I want to add the value of that header, so as of now in the document I have seen how to add the key of the header but I have no idea how to add the value...
chichepo's avatar
chichepo
Champion Level 1
2 years ago

shivasai 
Pardon me, I missed the fact that you were in securityScheme.

I am not sure you can.

You are going to expose a kind of "sensitive" data.
In another hand, you may try to define a "Template" for the field (i.e.: APIKEY) to document the expected field content.

Let us know if you find something