forked from federecio/dropwizard-swagger
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request federecio#60 from smoketurner/jp-auth-filter
Add auth filter
- Loading branch information
Showing
3 changed files
with
63 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
59 changes: 59 additions & 0 deletions
59
src/main/java/io/federecio/dropwizard/swagger/AuthParamFilter.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
// Copyright (C) 2014 Federico Recio | ||
/** | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
package io.federecio.dropwizard.swagger; | ||
|
||
import java.util.List; | ||
import java.util.Map; | ||
import io.swagger.core.filter.SwaggerSpecFilter; | ||
import io.swagger.model.ApiDescription; | ||
import io.swagger.models.Model; | ||
import io.swagger.models.Operation; | ||
import io.swagger.models.parameters.Parameter; | ||
import io.swagger.models.properties.Property; | ||
|
||
/** | ||
* This SwaggerSpecFilter checks for the presence of an | ||
* access=internal @ApiParam annotation, and hides the parameter if it is | ||
* present. | ||
* | ||
* This is primarily useful for hiding Dropwizard @Auth parameters. | ||
* | ||
* From: https://www.reonomy.com/augmenting-dropwizard-with-swagger/ | ||
*/ | ||
public class AuthParamFilter implements SwaggerSpecFilter { | ||
@Override | ||
public boolean isOperationAllowed(Operation operation, ApiDescription api, | ||
Map<String, List<String>> params, Map<String, String> cookies, | ||
Map<String, List<String>> headers) { | ||
return true; | ||
} | ||
|
||
@Override | ||
public boolean isParamAllowed(Parameter parameter, Operation operation, | ||
ApiDescription api, Map<String, List<String>> params, | ||
Map<String, String> cookies, Map<String, List<String>> headers) { | ||
String access = parameter.getAccess(); | ||
if (access != null && access.equals("internal")) | ||
return false; | ||
return true; | ||
} | ||
|
||
@Override | ||
public boolean isPropertyAllowed(Model model, Property property, | ||
String propertyName, Map<String, List<String>> params, | ||
Map<String, String> cookies, Map<String, List<String>> headers) { | ||
return true; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters