Comment masquer un paramètre dans swagger?

quelqu'un a réussi à cacher un paramètre de documentation générée? J'ai trouvé un problème ici, mais à l'aide de @ApiParam(access="internal", required=false) avant @HeaderParam n'a pas l'air de fonctionner.

InformationsquelleAutor eugen-fried | 2014-04-02
  1. 8

    Ok, en regardant les tests unitaires aidé. Vous devez d'abord définir un filtre:

    import com.wordnik.swagger.core.filter.SwaggerSpecFilter
import com.wordnik.swagger.model.{Parameter, ApiDescription, Operation}
import java.util

class MySwaggerSpecFilter extends SwaggerSpecFilter{
  override def isOperationAllowed(operation: Operation, api: ApiDescription, params: util.Map[String, util.List[String]], cookies: util.Map[String, String], headers: util.Map[String, util.List[String]]): Boolean = true

  override def isParamAllowed(parameter: Parameter, operation: Operation, api: ApiDescription, params: util.Map[String, util.List[String]], cookies: util.Map[String, String], headers: util.Map[String, util.List[String]]): Boolean = {
    if(parameter.paramAccess == Some("internal")) false
    else true
  }
}

    Et puis l'activer dans web.xml

        <servlet>
        <servlet-name>DefaultJaxrsConfig</servlet-name>
        <servlet-class>com.wordnik.swagger.jaxrs.config.DefaultJaxrsConfig</servlet-class>
        ...
        <init-param>
            <param-name>swagger.filter</param-name>
            <param-value>com.example.MySwaggerSpecFilter</param-value>
        </init-param>
    </servlet>
    InformationsquelleAutor eugen-fried
  2. 7

    Espère que cette aide.

    Pour Les Champs

    @ApiModelProperty(required = false, hidden = true)
private String hiddenProperty

    Pour Les Api

    @ApiIgnore
public class MyApi {}

    Pour Les Paramètres

    public void getApi(@ApiIgnore String param){}

@ApiModelProperty(hidden="true")
public String paramInsideClass
    InformationsquelleAutor Ronny Shibley
  3. 3

    Avec swagger-spring mvc (https://github.com/springfox/springfox) pour le moment il n'y a pas moyen d'utiliser SwaggerSpecFilter. Mais il respecte @ApiIgnore annotation - il peut être appliqué à la méthode de paramètre qui ne devrait pas apparaître dans les métadonnées générées.

    InformationsquelleAutor Paul Lysak
  4. 1

    Dans sprigfox-swagger2 mise en œuvre il y a une annotation @ApiModelProperty qui fait cela.

    Exemple:

    @ApiModelProperty(required = false, hidden = true)
private String internallyUsedProperty;
    InformationsquelleAutor magiccrafter
  5. 0

    Cette réponse décrit la solution actuelle dans springfox à l'aide de .ignoredParameterTypes ou @ApiIgnore

    InformationsquelleAutor gogstad
  6. 0

    Annotation @ApiParam(hidden = true) le problème est réglé pour moi. 

    def myFunc(@ApiParam(hidden = true) i: Int) = {...}
    • n'existent pas. au moins pas dans 1.5.0
    • Vérifié sur un ressort projet, celui-ci fonctionne
    InformationsquelleAutor Vasyl Yamnych