{"id":66518,"date":"2020-09-02T06:26:54","date_gmt":"2020-09-02T06:26:54","guid":{"rendered":"https:\/\/www.baeldung.com\/?p=86473"},"modified":"2020-09-02T06:26:54","modified_gmt":"2020-09-02T06:26:54","slug":"hiding-endpoints-from-swagger-documentation-in-spring-boot","status":"publish","type":"post","link":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/2020\/09\/02\/hiding-endpoints-from-swagger-documentation-in-spring-boot\/","title":{"rendered":"Hiding Endpoints From Swagger Documentation in Spring Boot"},"content":{"rendered":"

<\/p>\n

1. Overview<\/h2>\n
<\/div>\n

While creating Swagger documentation, we often need to hide endpoints from being exposed to end-users. The most common scenario to do so is when an endpoint is not ready yet. Also, we could have some private endpoints which we don’t want to expose.<\/p>\n

In this short article, we’ll have a look at how we can hide endpoints from Swagger API documentation<\/a>. To achieve this, we’ll be using annotations in our controller class.<\/p>\n

2. Hiding an Endpoint with @ApiIgnore<\/em><\/h2>\n
<\/div>\n

The\u00a0@ApiIgnore<\/em> annotation allows us to hide an endpoint<\/strong>. Let’s add this annotation for an endpoint in our controller:<\/p>\n

@ApiIgnore\r\n@ApiOperation(value = \"This method is used to get the author name.\")\r\n@GetMapping(\"\/getAuthor\")\r\npublic String getAuthor() {\r\n    return \"Umang Budhwar\";\r\n}<\/code><\/pre>\n
3. Hiding an Endpoint with @ApiOperation<\/em><\/h2>\n
<\/div>\n
Alternatively, we can use @ApiOperation<\/em> to hide a single endpoint<\/strong>:<\/p>\n
@ApiOperation(value = \"This method is used to get the current date.\", hidden = true)\r\n@GetMapping(\"\/getDate\")\r\npublic LocalDate getDate() {\r\n    return LocalDate.now();\r\n}<\/code><\/pre>\n
Notice that we need to set the\u00a0hidden<\/em> property to\u00a0true<\/em><\/strong> to make Swagger ignore this endpoint.<\/p>\n
4. Hiding all Endpoints with @ApiIgnore<\/em><\/h2>\n
<\/div>\n
Nonetheless, sometimes we need to hide all the endpoints of a controller class<\/strong>. We can achieve this by annotating the controller class with @ApiIgnore<\/em>:<\/p>\n
@ApiIgnore\r\n@RestController\r\npublic class RegularRestController {\r\n    \/\/ regular code\r\n}<\/code><\/pre>\n
It is to be noted that this will hide the controller itself from the documentation.<\/strong><\/p>\n
5. Conclusion<\/h2>\n
<\/div>\n
In this tutorial, we’ve seen how we can hide the endpoints from Swagger documentation. We discussed how to hide a single endpoint and also all the endpoints of a controller class.<\/p>\n
As always, the complete code for this example is available over on GitHub<\/a>.<\/p>\n
The post Hiding Endpoints From Swagger Documentation in Spring Boot<\/a> first appeared on Baeldung<\/a>.<\/p>\n
\"\"<\/p>\n
<\/a> <\/a> <\/a> <\/a> <\/a> <\/a> <\/a> <\/a> <\/div>\n\n
\\\"IT\u96fb\u8166\u88dc\u7fd2
\u7acb\u523b\u8a3b\u518a\u53ca\u5831\u540d\u96fb\u8166\u88dc\u7fd2\u8ab2\u7a0b\u5427!<\/figcaption><\/figure>\r\n<\/br>Find A Teacher Form:\r\n<\/br>https:\/\/docs.google.com\/forms\/d\/1vREBnX5n262umf4wU5U2pyTwvk9O-JrAgblA-wH9GFQ\/viewform?edit_requested=true#responses\r\n<\/br><\/br>Email:\r\n<\/br>public1989two@gmail.com






\r\nwww.itsec.hk<\/a>
\r\nwww.itsec.vip<\/a>
\r\nwww.itseceu.uk<\/a>
<\/p>","protected":false},"excerpt":{"rendered":"
Let’s have a look at how we can hide endpoints from Swagger API documentation.<\/p>\n
The post Hiding Endpoints From Swagger Documentation in Spring Boot<\/a> first appeared on Baeldung<\/a>.<\/p>\n
<\/a> <\/a> <\/a> <\/a> <\/a> <\/a> <\/a> <\/a> <\/div>\n<\/div>","protected":false},"author":214,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"slim_seo":{"title":"Hiding Endpoints From Swagger Documentation in Spring Boot - ITTeacherITFreelance.hk","description":"Let's have a look at how we can hide endpoints from Swagger API documentation. The post Hiding Endpoints From Swagger Documentation in Spring Boot first appeare"},"footnotes":""},"categories":[6],"tags":[],"_links":{"self":[{"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/posts\/66518"}],"collection":[{"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/users\/214"}],"replies":[{"embeddable":true,"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/comments?post=66518"}],"version-history":[{"count":9,"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/posts\/66518\/revisions"}],"predecessor-version":[{"id":71572,"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/posts\/66518\/revisions\/71572"}],"wp:attachment":[{"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/media?parent=66518"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/categories?post=66518"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/itteacheritfreelance.hk\/wordpress\/index.php\/wp-json\/wp\/v2\/tags?post=66518"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}