Over a million developers have joined DZone.

Technique to Shield Your API With @Namebinding

When we develop a REST API for our business, we may need to protect some of our APIs using API key or some kind of security mechanism.

· Integration Zone

Learn how API management supports better integration in Achieving Enterprise Agility with Microservices and API Management, brought to you in partnership with 3scale

Problem:

When we develop a REST API for our business, we may need to protect some of our APIs using API key or some kind of security mechanism. This can be achieved using Container Request Filter option available in Jersey framework. But in some cases we may need to ignore this validation or bypass this filter and allow our API call. For example, we can consider user CRUD REST API. /users is our main entry point to reach our REST API. Here, registering a user doesn’t require any kind of security check, whereas, when getting the user information, we need some kind of security restrictions. How can this be achieved using the Jersey framework?

Solution:

To achieve the above use case, we can use the @NameBinding annotation, which is available in Jersey. Follow the 3 simple steps to get that working.

  • Introduce an interface with the @NameBinding annotation.
  • Introduce a Container Request filter with our custom annotation.
  • Use our annotation in our API (to require the security check).

@NameBinding annotation

Filter with annotation

Resource method with annotation

We are done with our implementation. When you try to access the GET API, it will ask you to pass the X-API-KEY header value along with your header parameter. whereas when you access the POST API, it won’t ask you for any header.

Cool, right?

I hope you have enjoyed this article. Please share the article with your friends and ask questions if you have any!

Unleash the power of your APIs with future-proof API management - Create your account and start your free trial today, brought to you in partnership with 3scale.

Topics:
api security ,api key

Published at DZone with permission of Thamizh Arasu, DZone MVB. See the original article here.

Opinions expressed by DZone contributors are their own.

The best of DZone straight to your inbox.

SEE AN EXAMPLE
Please provide a valid email address.

Thanks for subscribing!

Awesome! Check your inbox to verify your email so you can start receiving the latest in tech news and resources.
Subscribe

{{ parent.title || parent.header.title}}

{{ parent.tldr }}

{{ parent.urlSource.name }}