added the skipTags query param for the endpoint /springfox-loader/api-docs

Author: jarlehansen

README.md

@@ -126,7 +126,7 @@ __Application properties__
 * springfox.license.url
 * springfox.activeProfiles - _Enable springfox for the configured profiles. If not set, all profiles loads springfox. Default is all profiles._
 * springfox.swagger-ui-base-path
-* springfox.endpoints - _Enables springfox-loader endpoints, `/springfox-loader/api-docs`. Is [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS) enabled._
+* springfox.endpoints - _Enables springfox-loader endpoints, see [Springfox loader endpoints](#springfox-loader-endpoints) for more details_
 
 ### Swagger UI
 
@@ -150,6 +150,13 @@ public void init() {
 }
 ```
 
+### Springfox loader endpoints
+
+`GET /springfox-loader/api-docs`
+ 
+ Returns the swagger api-docs with [CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS) enabled.  
+ Also has the option to remove the tags from the json response by adding `?skipTags=true` as a query param.
+
 ### References
 * [Springfox Reference Documentation](http://springfox.github.io/springfox/docs/current/)
 * [Swagger Core Annotations](https://github.com/swagger-api/swagger-core/wiki/Annotations-1.5.X)

pom.xml

@@ -17,6 +17,7 @@
         <lombok.version>1.16.16</lombok.version>
         <reflections.version>0.9.11</reflections.version>
         <guava.version>22.0</guava.version>
+        <jsonpath.version>2.2.0</jsonpath.version>
 
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <java.version>1.8</java.version>
@@ -72,6 +73,11 @@
             <artifactId>guava</artifactId>
             <version>${guava.version}</version>
         </dependency>
+        <dependency>
+            <groupId>com.jayway.jsonpath</groupId>
+            <artifactId>json-path</artifactId>
+            <version>${jsonpath.version}</version>
+        </dependency>
         <dependency>
             <groupId>org.projectlombok</groupId>
             <artifactId>lombok</artifactId>

src/main/java/com/github/springfox/loader/controller/SpringfoxLoaderController.java

@@ -2,6 +2,7 @@
 
 import com.github.springfox.loader.SpringfoxLoaderProps;
 import com.google.common.collect.Lists;
+import com.jayway.jsonpath.JsonPath;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
 import org.springframework.http.HttpEntity;
@@ -10,6 +11,7 @@
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 import org.springframework.web.client.RestTemplate;
 import org.springframework.web.servlet.support.ServletUriComponentsBuilder;
@@ -33,9 +35,15 @@ public SpringfoxLoaderController() {
     }
 
     @GetMapping("/api-docs")
-    public ResponseEntity getApiDocs(HttpServletRequest request) throws IOException {
+    public ResponseEntity getApiDocs(HttpServletRequest request, @RequestParam(required = false) Boolean skipTags) throws IOException {
         UriComponents uri = ServletUriComponentsBuilder.fromServletMapping(request).path("/v2/api-docs").build();
         ResponseEntity<String> response = restTemplate.exchange(uri.toString(), HttpMethod.GET, new HttpEntity<>(null), String.class);
-        return new ResponseEntity<>(response.getBody(), headers, response.getStatusCode());
+
+        String json = response.getBody();
+        if (skipTags != null && skipTags) {
+            json = JsonPath.parse(json).set("$.tags", new String[]{}).jsonString();
+        }
+
+        return new ResponseEntity<>(json, headers, response.getStatusCode());
     }
 }

src/test/groovy/com/github/springfox/loader/controller/SpringfoxLoaderControllerSpec.groovy

@@ -8,7 +8,9 @@ import org.springframework.test.web.servlet.setup.MockMvcBuilders
 import org.springframework.web.client.RestTemplate
 import spock.lang.Specification
 
+import static org.hamcrest.Matchers.hasSize
 import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath
 import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status
 
 class SpringfoxLoaderControllerSpec extends Specification {
@@ -30,4 +32,14 @@ class SpringfoxLoaderControllerSpec extends Specification {
         1 * restTemplate.exchange('http://localhost/v2/api-docs', HttpMethod.GET, _ as HttpEntity, String) >> ResponseEntity.ok('')
         response.andExpect(status().isOk())
     }
+
+    def "GET api-docs and skip tags"() {
+        when:
+        def response = mockMvc.perform(get('/springfox-loader/api-docs').param('skipTags', 'true'))
+
+        then:
+        1 * restTemplate.exchange('http://localhost/v2/api-docs', HttpMethod.GET, _ as HttpEntity, String) >> ResponseEntity.ok('{ "tags": [ "test123", "test234" ] }')
+        response.andExpect(status().isOk())
+                .andExpect(jsonPath('$.tags', hasSize(0)))
+    }
 }