rest - Swagger Java common header -


i have rest api server implemented jersey2.0 , integrated swagger automate docs , client side applications.

we have our own authentication header (x-auth-token) should applied requests in order use them (beside login request retrieves token if credentials correct).

right need manually add the token apiimplicitparam annotation each of requests in order generated docs include it:

@apiimplicitparams({@apiimplicitparam(name = authfilter.authorization_property, value = "authorization token", required = true, datatype = "string", paramtype = "header")})

i don't want hardcode ui code add header itself, believe violated api encapsulation provided swagger.json. server definition should provide details necessary generated docs.

is there way define custom default annotation requests in swagger? or alternatively use kind of filter achieve it?

a quick @ annotations

the apiimplicitparam , apiimplicitparams annotations defined following:

@target(value=method) @retention(value=runtime) public @interface apiimplicitparam  @target(value=method) @retention(value=runtime) public @interface apiimplicitparams

please note @target(value=method). means these annotations can applied methods.

for more details, check documentation.

what swagger ui can you

in swagger ui version 2.1.4 released on 6th january 2016 (the recent version when answer written), can have api key:

swagger ui page header api key

have @ index.html. default implementation sends api key query parameter:

function addapikeyauthorization(){     var key = encodeuricomponent($('#input_apikey')[0].value);     if(key && key.trim() != "") {         var apikeyauth = new swaggerclient.apikeyauthorization("api_key", key, "query");         window.swaggerui.api.clientauthorizations.add("api_key", apikeyauth);         log("added key " + key);     } }

but can change send http header:

function addapikeyauthorization(){     var key = encodeuricomponent($('#input_apikey')[0].value);     if(key && key.trim() != "") {         swaggerui.api.clientauthorizations.add("key",              new swaggerclient.apikeyauthorization("authorization", key, "header"));         log("added authorization header " + key);     } }

consider, example, api key you've entered in box credentials. when sending request, credentials value sent in authorization header (or in header you've defined):

request authorization header

for additional details, have documentation.

just quick hint

when testing pet store example, ensure header you've added matches values of header access-control-allow-headers. pet store example, allowed headers content-type, api_key , authorization.

hence, if try adding x-auth-token header in pet store example, you'll have following error:

xmlhttprequest cannot load http://petstore.swagger.io/v2/pet/findbystatus?status=active. request header field x-auth-token not allowed access-control-allow-headers in preflight response.


Comments

Post a Comment

Popular posts from this blog

javascript - jQuery: Add class depending on URL in the best way -

i have html progress meter: <div class="col-md-3" style="margin-left: -20px;"> <div class="progress-pos active" id="progess-1"> <div class="progress-pos-inner"> login </div> </div> </div> <div class="col-md-3 progress-pos-container"> <div class="progress-pos" id="progess-2"> <div class="progress-pos-inner"> scan items </div> </div> </div> <div class="col-md-3 progress-pos-container"> <div class="progress-pos" id="progess-3"> <div class="progress-pos-inner"> confirm address </div> </div> </div> <div class="col-md-3 progress-pos-container"> <div class="progress-pos" id="progess-4"> <div class="progress-pos-in...
Read more

caching - How to check if a url path exists in the service worker cache -

i need check if particular url path exists in service worker cache. example, suppose url is: /myserviceworker/service?a=110&b=70 this url exists in cache, there many of them different values of , b. now, suppose want refresh of these urls, how can that? i want know how access key values service worker cache. if know key, plan follows: var url = new url(key); if(url.pathname === "\/myserviceworker/service") refetch key but not sure how cache key , in format is. mean, string or url? cache api has match() method returns promise resolving in response object if match or undefined if no match exists. second parameter object can specify ignoresearch not take account url parameters. the ignoresearch option supported firefox ( chrome status here ). in other hand, retrieve cache entries, can use keys() method.
Read more

Redirect to a HTTPS version using .htaccess -

i need modify .htaccess file redirect urls https version without "www". http://example.com --> https://example.com http://www.example.com --> https://example.com https://www.example.com --> https://example.com this how .htaccess file looks like: rewriteengine on rewritecond %{request_filename} !-d rewritecond %{request_filename} !-f rewriterule ^(.*)$ redirect.php?id=$1&page=$2 [qsa,l] what modifications need make .htaccess in order forward https without "www"? it depends on doing current code. looks file called redirect trying display php page seo friendly url. think might confusing people. anyway, need , force https without www, need 1 more rule above. also second rule needs two capture groups in rewriterule test string because wanting 2 different values using $1 , $2 references. rewriteengine on #rediect www non www and/or http https --- combinations. rewritecond %{http_host} !^example\.com [nc,or] rewritecond %{https} !^...
Read more