JSONDoc流不在文档中显示

时间:2015-09-29 23:31:36

标签: jsondoc

我正在使用JSONDoc来获取REST API的文档,并且出于某种原因,Flow仅显示描述并给出错误

  

以下错误会妨碍操场的正确功能   并且没有为API用户提供足够的文档数据:

- No method found with id: SESSION_CREATE

我在类中定义的流常量如下:

public class APIFlowConstants {

    public final static String SESSION_CREATE = "SESSION_CREATE";

    public static final String CREATE_RFI = "CREATE_RFI";
    public static final String GET_RFI = "GET_RFI";
    public static final String LIST_RFIS = "LIST_RFIS";
    public static final String UPDATE_RFI = "UPDATE_RFI";
    public static final String DELETE_RFI = "DELETE_RFI";
}

我有一个这样注释的控制器类:

@ApiMethod(id = APIFlowConstants.CREATE_RFI)
    @RequestMapping(value = "/", method = RequestMethod.GET)
    public List<BAMRfi> getAllRfis(){
        java.util.List<BAMRfi> rfis = bamRfiRepository.findAll();
        return rfis;
    }
@ApiMethod(id = APIFlowConstants.SESSION_CREATE)
    @RequestMapping(value = "/", method = RequestMethod.GET)
    public String getSessionToken(@PathVariable(value="seed") String seed){
        String token = Token.getToken(seed);
        return token;
    }

和这样的流程控制类:

@ApiFlow(name = "Create RFI Flow", description = "creates a new BAM RFI", steps = {
            @ApiFlowStep(apimethodid = APIFlowConstants.SESSION_CREATE),
            @ApiFlowStep(apimethodid = APIFlowConstants.CREATE_RFI) })
    public void rfiCreateFlow() {
    }

不确定为什么流程没有找到匹配的ID,我使用的是版本1.2.5并使用Java 8进行编译。

1 个答案:

答案 0 :(得分:0)

您似乎没有使用@ApiMethod(id = APIFlowConstants.SESSION_CREATE)注释的方法。在您报告的代码中,您只有一个使用@ApiMethod(id = APIFlowConstants.CREATE_RFI)

注释的方法