如何在swagger中隱藏參數？

有沒有人成功隱藏生成文檔中的參數？我發現一個問題here，但在@HeaderParam之前使用@ApiParam(access="internal", required=false)似乎不起作用。如何在swagger中隱藏參數？

2014-04-02 yevgeniy mordovkin

好吧，看單元測試幫助。首先，你需要定義過濾器：在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>

來源

2014-04-02 14:05:20

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 
    } 
}

，然後啓用它與有沒有辦法用SwaggerSpecFilter時刻招搖，用SpringMVC（https://github.com/springfox/springfox）。但它遵守@ApiIgnore註釋 - 它可以應用於不應出現在生成的元數據中的方法參數。

來源

2015-03-24 11:04:38

在sprigfox-swagger2實現中有一個註釋@ApiModelProperty這樣做。

例子：

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

來源

2016-01-12 15:35:23 magiccrafter

This答案描述了使用.ignoredParameterTypes或@ApiIgnore

來源

2016-05-19 07:31:28 gogstad

希望這有助於在springfox當前的解決方案。

字段的

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

原料藥

@ApiIgnore 
public class MyApi {}

對於參數

public void getApi(@ApiIgnore String param){} 

@ApiModelProperty(hidden="true") 
public String paramInsideClass

來源

2017-01-16 13:31:09

如何在swagger中隱藏參數？

回答

相關問題